Re: [Numpy-discussion] coding style: citations

2009-01-23 Thread Alan G Isaac
Tim Michelsen wrote: > did you already come to a conclusion regarding this cite topic? > Did you try to run the bibtext extension for Sphinx? > If so, please update the documentation guidelines. I hope we reached agreement that the documentation should use reST citations and not reST footnotes. Y

Re: [Numpy-discussion] coding style: citations

2009-01-23 Thread Stéfan van der Walt
Hi Tim 2009/1/22 Tim Michelsen : > did you already come to a conclusion regarding this cite topic? > > Did you try to run the bibtext extension for Sphinx? I haven't tried it. One difficulty is that each docstring needs to be self-contained, i.e., it must include its own references. If you want

Re: [Numpy-discussion] coding style: citations

2009-01-23 Thread Tim Michelsen
Hello Allan, Stefan and others, did you already come to a conclusion regarding this cite topic? Did you try to run the bibtext extension for Sphinx? If so, please update the documentation guidelines. Regards, Timmie ___ Numpy-discussion mailing list N

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Tim Michelsen
> If I understand, you are using bib4txt.py to do this? Yes, I use bib4txt.py. The extension just runs bib4txt.py over all documents to extract the citations. Then it creates the reference file. The bibtex file is also converted to ReSt using your tools. But since the bibstuff needs the citation

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Robert Kern
On Tue, Jan 13, 2009 at 13:36, Alan G Isaac wrote: > On 1/13/2009 1:55 PM Tim Michelsen apparently wrote: >> Please have a look at: >> http://bitbucket.org/birkenfeld/sphinx/issue/63/make-sphinx-read-bibtex-files-for >> >> And the example Sphinx project at: >> #3 - >> http://bitbucket.org/birkenfe

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Alan G Isaac
On 1/13/2009 1:55 PM Tim Michelsen apparently wrote: > Please have a look at: > http://bitbucket.org/birkenfeld/sphinx/issue/63/make-sphinx-read-bibtex-files-for > > And the example Sphinx project at: > #3 - > http://bitbucket.org/birkenfeld/sphinx/issue/63/make-sphinx-read-bibtex-files-for#comme

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Tim Michelsen
Hello, I really like the discussion here. > Originally I was just pointing out a problem. > Proposing a good solution requires some discussion. > The problem has also changed because of a suggestion > that the docs should be usable for book compilation, > and I am very uncertain how that is conce

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Alan G Isaac
> 2009/1/13 Alan G Isaac : >> There really is no substitute for using real cite keys >> and a central database of citations. On 1/13/2009 9:44 AM Stéfan van der Walt apparently wrote: > How do you propose getting the citations into the docstrings? Each > docstring needs a copy of its references,

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Stéfan van der Walt
2009/1/13 Alan G Isaac : > There really is no substitute for using real cite keys > and a central database of citations. How do you propose getting the citations into the docstrings? Each docstring needs a copy of its references, and those references may be to specific pages. I don't recall ReST

Re: [Numpy-discussion] coding style: citations

2009-01-13 Thread Alan G Isaac
> 2009/1/12 Alan G Isaac : >> Numerical keys will clearly *not* be consistent. >> The same key will refer to different citations >> on different pages, and key width will not be >> uniform. On 1/12/2009 2:35 AM Stéfan van der Walt apparently wrote: > We automatically renumber the citations to tak

Re: [Numpy-discussion] coding style: citations

2009-01-12 Thread jh
Well, best to have the full functionality. These things are intended to be both book components and stand-alone pages. Citation formats are a religious war anyway. --jh-- Date: Mon, 12 Jan 2009 12:41:17 -0500 From: Alan G Isaac Subject: Re: [Numpy-discussion] coding style: citations To

Re: [Numpy-discussion] coding style: citations

2009-01-12 Thread Alan G Isaac
On 1/12/2009 9:08 AM j...@physics.ucf.edu apparently wrote: > For citation keys, what's wrong with good old author-year format? > Most scientific journals use it (Abt 1985). > Abt, H. 1985. Harold Abt used to publish surveys of things like > citations when he was ApJ editor in the 1980s but I

Re: [Numpy-discussion] coding style: citations

2009-01-12 Thread jh
> ... citations ... BibTeX Please ensure that, whatever you come up with, it is *very intuitive* for the writer to enter the citation data, or we will quickly lose citations, and possibly writers. For example, I would not have them type in BibTeX entries, but rather provide boxes where they can e

Re: [Numpy-discussion] coding style: citations

2009-01-11 Thread Stéfan van der Walt
2009/1/12 Alan G Isaac : > This would really involve the following. > Create a searchable database of citations > and an interface for adding to it. > Unique keys would be generated by your > algorithm of choice when an entry is added. > Authors would be asked to use only references > in the databa

Re: [Numpy-discussion] coding style: citations

2009-01-11 Thread Alan G Isaac
On 1/11/2009 4:13 PM Stéfan van der Walt apparently wrote: > Thank you for your feedback. Yes, this is a problem. In a way, > RestructuredText is partially to blame for not providing numerical > citation markup. I do not agree. I cannot think of any bibliography tool that uses numerical citati

Re: [Numpy-discussion] coding style: citations

2009-01-11 Thread Stéfan van der Walt
Hi Alan 2009/1/11 Alan G Isaac : > The docstring standard at > http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines#docstring-standard > suggests a citation reference format that is not compatible > with reStructuredText. Quoting from > http://docutils.sourceforge.net/docs/ref/rst/res

[Numpy-discussion] coding style: citations

2009-01-11 Thread Alan G Isaac
The docstring standard at http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines#docstring-standard suggests a citation reference format that is not compatible with reStructuredText. Quoting from http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#citations: Citat