[sphinx-dev] Sphinx: Co-Maintainer(s) wanted

2012-10-28 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Dear Sphinx users, dear Python community, unfortunately, it has turned out that at the moment I don't have enough spare time to fulfill my duties as Python core developer and release manager, as well as fully maintain my other open-source projects.

Re: [sphinx-dev] autodoc and module variables

2012-03-17 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 I agree. I will fix the doc to make this clearer. cheers, Georg On 03/16/2012 11:54 AM, Rob Reilink wrote: I have to say that the doc is not very clear: ...'documentation can either be put into a special-formatted comment'... but the colon is not

Re: [sphinx-dev] Re: Exception when using Sphinx 1.1.2 to create the Leo documentation

2012-03-14 Thread Georg Brandl
On 14.03.2012 16:15, VR wrote: Hello everyone, Am Samstag, 18. Februar 2012 09:36:39 UTC+1 schrieb VR: when running Sphinx 1.1.2 I receive the following exception. - See 'Log-1' for the exception: log-1 ... /log-1 and 'Log-2' for the output from

Re: [sphinx-dev] PULL REQ: Add URL #anchor checking to 'linkcheck' builder

2012-03-10 Thread Georg Brandl
On 07.03.2012 17:23, Marti Raudsepp wrote: Hi! Last week I submitted a pull request to the Sphinx Bitbucket repository, but there has been no activity on the request. Is there another way to submit patches to Sphinx? Anyway, the patch downloads all pages that have '#' in their address, and

[sphinx-dev] Sphinx 1.1.3 released

2012-03-10 Thread Georg Brandl
Hi all, I'm happy to announce the release of Sphinx 1.1.3. It fixes over 20 bugs and buglets in the 1.1 series of Sphinx. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of

Re: [sphinx-dev] How to reduce memory usage of sphinx-build

2012-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 01/06/2012 03:44 PM, Neck Acm wrote: Hi all, I am new to sphinx, I am trying to convert massive plain text files to well-organized html, not program documentation, just some plain text record. The source text files is about 116 MB, I use

Re: [sphinx-dev] Re: Some characters rendering wrongly in HTML title output

2011-11-25 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 25.11.2011 22:17, schrieb Guenter Milde: On 2011-11-25, Guenter Milde wrote: On 2011-11-25, Friedrich Romstedt wrote: Am 25.11.2011 um 08:44 schrieb Guenter Milde mi...@users.sf.net: On 2011-11-24, Friedrich Romstedt wrote: I'm experiencing

Re: [sphinx-dev] Override the release name

2011-11-01 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/31/2011 06:14 PM, Jan Ulrich Hasecke wrote: Hi, is it possible to overwrite the release name in Sphinx. I want to have a custom name (subtitle) on the pdf-output. You can set release in conf.py, or give it on the command line, with the

Re: [sphinx-dev] Re: parsed-literal problems

2011-11-01 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/29/2011 01:19 PM, Guenter Milde wrote: On 2011-10-29, Andrea Crotti wrote: On 10/28/2011 10:28 PM, Guenter Milde wrote: What do you expect and what do you get? I would think to get the code highlighted, instead is just not recognized as

Re: [sphinx-dev] Override the release name

2011-11-01 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 11/01/2011 09:43 AM, Jan Ulrich Hasecke wrote: Am 01.11.11 08:50, schrieb Georg Brandl: On 10/31/2011 06:14 PM, Jan Ulrich Hasecke wrote: Hi, is it possible to overwrite the release name in Sphinx. I want to have a custom name (subtitle

[sphinx-dev] Sphinx 1.1.1 released

2011-11-01 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.1.1, a bug-fix release in the 1.1 series, fixing a number of bugs of the initial 1.1 release. What is it? === Sphinx is a tool that makes it easy to create intelligent and beautiful

[sphinx-dev] Sphinx 1.1.2 released

2011-11-01 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm announcing the release of Sphinx 1.1.2, codename 1.1.1 Is A Silly Version Number Anyway. It fixes building from the source tarball with Python 3 by actually including our custom 2to3 fixers. What is it? === Sphinx is a tool

[sphinx-dev] Sphinx 1.1 released

2011-10-09 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.1, a new feature release. The full changelog is at http://sphinx.pocoo.org/changes.html. Highlights == * Added Python 3.x support. * Added a Texinfo builder. * Added i18n support for

Re: [sphinx-dev] referencing hyperlinks using :ref:

2011-10-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/06/11 22:00, Christian Rohling wrote: Hey everyone, I am new to sphinx, and am using it to document a project. I have run into a something that I feel I should be able to do, but cannot find out how. I want to reference a hyperlink section

Re: [sphinx-dev] disable search for html

2011-10-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/02/11 14:39, mbedward wrote: Hello folks, For html output, I would like to disable creation of the search index and search page but I haven't been able to find any clues on how to do this in the docs or archived posts. I suspect I'm

Re: [sphinx-dev] no quick search in Konqueror

2011-10-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/04/11 22:40, Paulette wrote: Hi, I have a user who cannot see the Quick Search box when he uses the Konqueror brower (on Linux). This search box appears for all the other browsers we tried (IE, Chrome, Safari, Firefox, etc.). If you look

Re: [sphinx-dev] sphinx tcl highlighting problem

2011-10-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/02/11 01:41, bulletmark wrote: The small tcl code fragment: .. code-block:: tcl :linenos: set a 1 puts ${a} fails to render in sphinx but does render when I run it through pygmentize manually. Also runs fine in tclsh of course. Have

Re: [sphinx-dev] Error in cpp:namespace directive

2011-10-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 09/30/11 19:39, Jack Poulson wrote: Hello, It would appear that the C++ domain's 'cpp:namespace' directive does not work (in 1.0.7 or 1.0.8). For instance, when adding in the following code: .. cpp:namespace:: mpi .. cpp:clase:: Test

Re: [sphinx-dev] sphinx v1.0.7/automodule does load package, only shared lib

2011-10-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 09/29/11 17:04, Avi Bahra wrote: If I have a C++ python extension say _ecflow.so. The normal convention is to place it in a directory with same name as extension. ecflow/ _ecflow.so __init__.py where __init__.py: has as the first line:

Re: [sphinx-dev] sphinx tcl highlighting problem

2011-10-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 10/05/11 16:02, bulletmark wrote: I was running pygmentize to my terminal and after your comment I have realized that some of the output is underlined so I guess that means pygmentize believes it is invalid syntax? Yep, this is how the default

Re: [sphinx-dev] Sphinx 1.0.8 released

2011-09-25 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 I see... this is with docutils 0.6, right? I'll update the tests to care for this case, but you should upgrade to at least 0.7 anyway. cheers, Georg Am 24.09.2011 21:12, schrieb Chris Lea: I get two errors when I try to run the test suite on an

Re: [sphinx-dev] Strange behaviour of :abbr:

2011-09-23 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 23.09.2011 09:31, schrieb Stefano David: Hi, I started using sphinx around six months ago and find it easy to use and powerful. I found, however, a problem when using :abbr:and I do not know whether it is a bug or something I am missing. So,

Re: [sphinx-dev] How do I add a cross-reference to js:attribute::

2011-09-23 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 31.08.2011 11:05, schrieb Frank Schröder: Hi, I have a list of js:attribute:: entries and I would like to cross-reference them within the same document. How do I do this? Something similar to this (which does not work for me). I'm using

[sphinx-dev] Sphinx 1.0.8 released

2011-09-23 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.0.8, a bug-fix release in the 1.0 series, fixing a large number of bugs in the 1.0 line of releases. The full changelog is at http://sphinx.pocoo.org/changes.html. What is it? ===

Re: [sphinx-dev] Re: Images and re-builds

2011-09-22 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 31.08.2011 21:24, schrieb Aivar: Hi! This quirk causes problems for me as well. I use Sphinx for generating course materials, where I occasionally update a chapter, rebuild and upload corresponding html file to the course site. Usually I

Re: [sphinx-dev] New extensions : word writer clearquest directive

2011-09-21 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.09.2011 15:09, schrieb Robin Jarry: Hello everyone, I've been using RST for over a year now and I wrote a couple of things around it. I don't know how I managed to miss the Sphinx project but hey, nobody's perfect :-) I would like to

Re: [sphinx-dev] Estonian translation

2011-09-19 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.09.2011 10:09, schrieb Aivar: Hi! I translated UI strings to Estonian (locale code 'et'). http://www.aivarannamaa.ee/sphinx/sphinx.po Hopefully this can be added to next release. Thank you! Please add it to a tracker issue, so that

Re: [sphinx-dev] Release of 1.1: any plans?

2011-06-22 Thread Georg Brandl
On 22.06.2011 22:00, Roberto Bagnara wrote: On 06/22/11 21:57, Georg Brandl wrote: On 22.06.2011 21:50, Roberto Bagnara wrote: On 02/28/11 20:09, Georg Brandl wrote: On 28.02.2011 19:41, Prof. Roberto Bagnara wrote: Has this been planned? I am looking forward to the possibility of having

Re: [sphinx-dev] Release of 1.1: any plans?

2011-02-28 Thread Georg Brandl
On 28.02.2011 19:41, Prof. Roberto Bagnara wrote: Has this been planned? I am looking forward to the possibility of having multiple terms per entry in a glossary. Unfortunately, I currently was and still am quite busy (as you also can see from my lack of responses to this list). But Python

Re: [sphinx-dev] automodule/autodoc line numbers impossible to interpret

2011-01-24 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 24.01.2011 20:24, schrieb Erik Tollerud: I've been making quite a bit of use of autodoc (specifically, automodule) for documenting a project. However, as the project has grown, I find it's difficult to tell where warnings are occurring in the

Re: [sphinx-dev] How does sphinx auto-generate nightly docs?

2011-01-24 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 24.01.2011 20:13, schrieb Erik Tollerud: I've noticed the sphinx latest documentation page seems to stay in sync with the development version on bitbucket. Is this done by an automatic tool to keep the documentation page up-to-date with the

Re: [sphinx-dev] productionlist/latex problem (regression I think)

2011-01-18 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.01.2011 15:47, schrieb Marcin Wojdyr: Yes, it was indeed. Should now be fixed with rev 70f2984f86d7. Thanks, the references work now. Is it possible to somehow switch off latex_show_pagerefs only for productionlists? Grammar rules

Re: [sphinx-dev] Using Sphinx in education

2011-01-16 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 22:12, schrieb Tim Bower: This is not exactly a new project using Sphinx, but I wanted to mention that I have been using Sphinx for course material delivery in college classes. I think Sphinx has a great deal of value to education

Re: [sphinx-dev] Intersphinx problem with Generator

2011-01-16 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.01.2011 12:47, schrieb cool-RR: Hello, I write :term:`generator` in my docs, and do `make html`, but it doesn't make a link to Python's documentation. I also tried prefixing it with :py, doesn't

Re: [sphinx-dev] Re: Using Sphinx with C extensions

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 13.01.2011 09:12, schrieb Jason: On Jan 13, 3:33 pm, Georg Brandl ge...@python.org wrote: Is there any way around this? Yes: build the C extension before you build the docs. I use distutils to build it all, which deposits everything

Re: [sphinx-dev] classes inside automodule

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 14.01.2011 09:59, schrieb Chris Withers: On 14/01/2011 03:58, TP wrote: If I do, for example: .. automodule:: testfixtures .. class:: Comparison ...then I end up with two sections for the Comparison class, one auto-generated and one

Re: [sphinx-dev] Add Sphinx project

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 13.01.2011 15:51, schrieb Andy Harrington: The Python 3.1 versio of my Hands-on Python Tutorial uses Sphinx for both the html and pdf versions. http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/

Re: [sphinx-dev] Projects using Sphinx

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 15:55, schrieb SHIBUKAWA Yoshiki: Hi, Many Sphinx sites in Japan are listed at the following page. http://sphinx-users.jp/example.html And I wrote 3 books with Sphinx(sorry, all of them are Japanese). 1. Simple and Steady

Re: [sphinx-dev] Projects using Sphinx

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 15:19, schrieb Jan Ulrich Hasecke: Hi, you may want to add two projects to the page: Projects using Sphinx Plone 4 Benutzerhandbuch (German) http://www.hasecke.com/plone-benutzerhandbuch/4.0/ and a non-software project:

Re: [sphinx-dev] Projects using Sphinx

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 16:00, schrieb Enrique J. Hernández Blasco: Sorry for hijacking the thread. We also use sphinx in an open-source project called Zentyal. The documentation is available at: http://doc.zentyal.org It would be great to add this

Re: [sphinx-dev] Feature request with :lines: with :linenos:

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 16:23, schrieb Andy Harrington: I suggest/request that either the default or at least an option with .. literalinclude:: :lines: 10-15 :linenos: be that the line numbers are in sync with the lines. The code above

Re: [sphinx-dev] Re: Problem with mailto: links

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 22:45, schrieb Giles Thomas: Georg Brandl wrote: Thanks for the reply. We're using docutils 0.7 too; we're still on Python 2.5, though. Might that be the problem, do you think? Hmm, I don't think so. I'll have a closer look

[sphinx-dev] Sphinx 1.0.7 released

2011-01-15 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.0.7, a bug-fix release in the 1.0 series, fixing a number of bugs in the 1.0 line of releases, most importantly a regression in LaTeX output introduced in 1.0.6. What is it? === Sphinx

Re: [sphinx-dev] Re: :param: and :keyword: rendering

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 09:14, schrieb Guenter Milde: On 2011-01-11, Guenter Milde wrote: On 2011-01-09, Vinay Sajip wrote: If would be neater if instead of strongparam_name/strong, the output markup was something like span

Re: [sphinx-dev] Re: Why won't this code highlight?

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 07:43, schrieb Kevin H: On Jan 12, 12:37 am, Kevin Horn kevin.h...@gmail.com wrote: here is a page of output from a sphinx project:http://twistedsphinx.funsize.net/projects/web/howto/resource-template... here is the source of that

Re: [sphinx-dev] Updating to new makefile

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 19:51, schrieb cool-RR: Thanks! Ram. On Tue, Jan 11, 2011 at 8:06 PM, DasIch dasdas...@googlemail.com mailto:dasdas...@googlemail.com wrote: There is no reason to update the makefile unless you want to use a new

Re: [sphinx-dev] productionlist/latex problem (regression I think)

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.01.2011 21:44, schrieb Marcin Wojdyr: Hello, I have such a thing: .. productionlist:: line: [`statement`] [`comment`] ... and if I use Sphinx 0.6.5 (from the python svn) to build latex, it builds cleanly:

Re: [sphinx-dev] Re: Problem with mailto: links

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 10.01.2011 12:22, schrieb Giles Thomas: On Jan 7, 10:22 am, Georg Brandl ge...@python.org wrote: Am 03.11.2010 16:46, schrieb Giles Thomas: One oddity we encountered today was that mailto: links seem to be excessively escaped in HTML output

Re: [sphinx-dev] autodoc and modules

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.01.2011 22:42, schrieb Vinay Sajip: Hi Georg, I'm not sure how to fix this. Even if you could get Sphinx to import the contents of baz via foo, the __module__ attribute of classes and functions would be wrong, and therefore these

Re: [sphinx-dev] Re: :param: and :keyword: rendering

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 12.01.2011 12:36, schrieb Fred Drake: On Wed, Jan 12, 2011 at 3:14 AM, Guenter Milde mi...@users.berlios.de wrote: Addition: to avoid confusion with keywords of a programming language, I change my suggestion to strong class=parameter kwarg

Re: [sphinx-dev] Using Sphinx with C extensions

2011-01-12 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 13.01.2011 05:05, schrieb Jason: I have written a Python module including a submodule written in C: the module itself is called foo and the C part is foo._bar. The structure looks like: src/ foo/__init__.py - contains the public stuff

Re: [sphinx-dev] Setting the depth of the sidebar TOC

2011-01-10 Thread Georg Brandl
, 2011 at 3:37 PM, Georg Brandl ge...@python.org mailto:ge...@python.org wrote: Am 23.12.2010 19:40, schrieb Gilmorez: It is very easy to set the depth of the TOC on an index page, and that is very handy. So far, in my attempts to figure out how to do the same for the sidebar TOC, I'm

Re: [sphinx-dev] Stripping module info in crossref

2011-01-08 Thread Georg Brandl
unless I write out the entire function's name. I was just figuring that it was something easy that I missed. Sphinx is still great though, thanks for all of the hard work. -- D. M. Monarres dmmonar...@gmail.com mailto:dmmonar...@gmail.com On Fri, Jan 7, 2011 at 2:27 AM, Georg Brandl ge

Re: [sphinx-dev] Re: Documenting functions declared with lambda or returned from higher order functions

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 FWIW, Sphinx trunk now picks up a signature from the first line of the docstring, if it finds one. Georg Am 09.04.2010 17:26, schrieb Michael Rule: I would be happy even with a variety of hacks : most of these functions are one-liners. Is there

Re: [sphinx-dev] [PATCH] add option pngmath_use_tooltips UPDATE

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 15.06.2010 22:54, schrieb Herbert Griebel: Unfortunately there was a missing format parameter in the code, here is an update with the fix. On 13.06.2010 20:45, Herbert Griebel wrote: add option pngmath_use_tooltips This option will show

Re: [sphinx-dev] Autodoc munging \n in function signatures

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 19.03.2010 20:12, schrieb Jeff Forcier: Hi, and thanks for Sphinx! It's great. I've encountered what seems like an odd problem with the autodoc plugin: a function signature with \n in a default value has the '\' stripped away, and thus any

Re: [sphinx-dev] Re: bibtex with autodoc

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 21.03.2010 21:44, schrieb Tim Michelsen: I was trying to use http://code.google.com/p/bibstuff/ to create rest- formatted bibliography from bibtex. It is able to scan rest file for references in source ReST files, but as I use autodoc, many

Re: [sphinx-dev] ctypes, alias instead of __doc__

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 26.04.2010 22:22, schrieb Roger Binns: I have this in my module, setting up something for a callback: LOGCB=ctypes.CFUNCTYPE(None, ctypes.c_char_p, ctypes.c_void_p) LOGCB.__doc__=Create LOGCB(your_py_func) and pass ... However the

Re: [sphinx-dev] ctypes, alias instead of __doc__

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 08.01.2011 23:20, schrieb Roger Binns: On 01/08/2011 01:33 PM, Georg Brandl wrote: The problem here is that LOGCB.__name__ is still CFunctionType, why ever. If you set LOGCB.__name__ = 'LOGCB' it is documented correctly. Thanks

Re: [sphinx-dev] how to include a class attribute in docs

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 27.04.2010 16:16, schrieb Robert Cimrman: Hi, I have a large number of classes that look like: class MyClass(object): A docstring name = 'a string' Is it possible somehow to include automatically the contents of

Re: [sphinx-dev] Documenting inherited members selectively

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 17.10.2010 20:36, schrieb Vinay Sajip: Is there a way of documenting inherited members selectively? Say I have a class which inherits from another class as an implementation detail. I want to document only certain inherited members. Hence:

Re: [sphinx-dev] autodoc and modules

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 19.10.2010 11:19, schrieb Vinay Sajip: I have the following simple code structure: code/ foo/ __init__.py from bar import baz from bar.baz import Baz bar/ __init__.py baz.py class Baz(object):

Re: [sphinx-dev] :param: and :keyword: rendering

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.10.2010 21:41, schrieb Vinay Sajip: Is there an easy way to have these styled differently, so it's more obvious what the keyword parameters are? Especially when the method signature uses **kwargs. Is there a particular reason why the

Re: [sphinx-dev] custom internal hyperlinking roles -- resolving xrefs

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 14.12.2010 00:21, schrieb Václav Šmilauer: Hello everybody, I am struggling with a simple thing (but I want to do it properly)... I want to create a custom internal hyperlinking role :yref:`target`, where target is transformed to yield name

Re: [sphinx-dev] Feedback for first pass bibtex extension?

2011-01-08 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 15.12.2010 21:41, schrieb Matthew Brett: Hi, I've been working for a few days on my first sphinx extension, an attempt to allow us to include citations from bibtex files. I wanted to ask for feedback about the design. In particular I hit a

Re: [sphinx-dev] little patch for autodoc

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.10.2010 22:00, schrieb Luc Saffre: Here is a little patch I suggest for autodoc. In :file:`sphinx/ext/autodoc.py` line 332 (meth:`Documenter.import.object`), add 2 lines:: except Exception, err: if

Re: [sphinx-dev] autodoc should tell which module caused an rst warning

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 16.10.2010 19:23, schrieb Luc Saffre: Hello, there is an annoying detail in autodoc: when I have some rst syntax warning in the docstring of one of my modules, then the output of sphinx-build doesn't indicate in which module the warning

Re: [sphinx-dev] Howto autodoc utility script

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 26.11.2010 21:56, schrieb Johan Ekh: Hi all, I'm new to Python and Sphinx. I'm developing a small python module that contains some classes and methods. In parallel I develop some utility scripts that imports the module and use the

Re: [sphinx-dev] Patch request for node line numbering

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 24.08.2010 15:53, schrieb Kevin Dunn: Hi, I'm developing a Sphinx extension and Django application that I hope to publicly release soon. The extension allows for commenting on each node in the documentation. Docutils makes the starting

Re: [sphinx-dev] Missleading error / warning output in class WarningStream (environment.py)

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.09.2010 13:28, schrieb Martin Brochhaus: Hello group, this is quite hard to explain and I don't understand the inner workings of the whole call stack that finally leads to a warning output when there are syntax errors in docstrings - but I

Re: [sphinx-dev] Problem with mailto: links

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 03.11.2010 16:46, schrieb Giles Thomas: Hi there, We've been using Sphinx to put together the docs for a new project -- fantastic tool, many thanks for making it available! One oddity we encountered today was that mailto: links seem to be

Re: [sphinx-dev] Request to be included on the list of projects using Sphinx

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.11.2010 20:19, schrieb Giles Thomas: Hi all, We've now uploaded the first cut of our documentation for our (commercial) product using Sphinx -- thanks once again to the creators for such a brilliant project! The docs are here:

Re: [sphinx-dev] download file missing

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 10.12.2010 07:22, schrieb monkut: I'm getting the following warning after change the name of ID_request.rng to something else. I've removed all :download: references to ID_request.rng from all my text source files, and removed (renamed) the

Re: [sphinx-dev] Stripping module info in crossref

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 07.01.2011 07:39, schrieb D. Monarres: Hello all, Right now I am trying to write a tutorial for the Sage computer algebra system that heavily cross-references with the standard documentation. Sage loads almost all functions/classes into the

Re: [sphinx-dev] proposed sphinx.ext.autodoc proposed change

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 02.04.2010 09:50, schrieb syt: Hi there, To be able to put more doc in code, I've developped a new simple autodoc directive which basically add a module docstring without anything else (eg no module 'signature', no members). This was

Re: [sphinx-dev] Re: Howto autodoc utility script

2011-01-07 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 07.01.2011 14:11, schrieb Jakob Malm: On 7 Jan, 10:23, Georg Brandl ge...@python.org wrote: which works fine. But how can I extract the docstrings from my utility scripts? You can't do that with autodoc if they are not importable

[sphinx-dev] Sphinx talk at PyCon 2011

2011-01-07 Thread Georg Brandl
Hi, this is just a short notice that there will be a talk about Sphinx at the US PyCon 2011, held by Brandon Craig Rhodes, formerly editor- in-chief of the Python Magazine: http://us.pycon.org/2011/schedule/sessions/219/ cheers, Georg signature.asc Description: OpenPGP digital signature

Re: [sphinx-dev] latexpdf Undefined control sequence. \MakeFramed

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 06.01.2011 03:51, schrieb steve: I've been banging my head against this one too long now.. Just started using sphinx yesterday... LOVE it! But... I just started incorporating actual code snippets and while HTML output works OK, when I try to

Re: [sphinx-dev] another code for the sphinx list

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 28.08.2010 00:18, schrieb j brandon keith: Hi, here is another code for the sphinx documentation list: http://docs.danse.us/pyre/sphinx/ Pyre is a service component framework. It also has a trac page at: http://dev.danse.us/trac/pyre.

Re: [sphinx-dev] Yet another project using Sphinx

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 08.08.2010 20:40, schrieb Luc Saffre: Please add Lino to the list of projects using Sphinx: http://lino.saffre-rumma.ee/ This is now added. Thanks, Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux)

Re: [sphinx-dev] Mishandling of C++ constant member functions

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 08.08.2010 21:57, schrieb Jack: I'm using Sphinx v1.0.1 and there does not appear to be a sane way to handle C++ const member functions. For example: .. cpp:class:: butterflyfio::ArrayT,d A simple template class for arrays of datatype

Re: [sphinx-dev] index directive followed by only directive crash latex and rst2pdf builders

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 06.05.2010 15:45, schrieb fgpy: Hi, When I try to `make latex`, I get the following error. Exception occurred: File C:\Python26\lib\site-packages\docutils\nodes.py, line 695, in replace_self 'Losing %s attribute: %s' % (att,

Re: [sphinx-dev] Re: Any plans for sphinx.ext.mathjax?

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 21.11.2010 21:50, schrieb Kevin Dunn: Hi everyone, Just to continue this thread, using MathJax in Sphinx is now even easier: FTR, I've just added Kevin's MathJax extension in trunk; it will be builtin in Sphinx 1.1. Thanks all! Georg

Re: [sphinx-dev] Re: Question about Verbatim redefinition

2011-01-06 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 09.12.2010 09:30, schrieb Lennart Regebro: On Thu, Dec 9, 2010 at 07:48, Guenter Milde mi...@users.berlios.de wrote: On 2010-12-08, Lennart Regebro wrote: In sphinx.sty there is a redefinition of Verbatim. In that there is a line

Re: [sphinx-dev] index directive prevents paragraph separation in LaTeX

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 07.10.2010 10:46, schrieb Markus Hubig: Hi @all, i'm fighting with a strage issue. If I put a .. index:: Bla- directive between two paragraphs the two paragraphs are later concatenated in the LaTeX output. FWIW, this should be fixed in

Re: [sphinx-dev] Re: Sphinx breaks with latest Docutils latex writer

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 14.11.2010 20:41, schrieb Guenter Milde: On 2010-11-11, dkuhlman wrote: I use Docutils from the SVN repository and Sphinx from the Mercurial repository. When building docs with make html, I got this exception: #

Re: [sphinx-dev] Sphinx output to Github

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.11.2010 21:17, schrieb Michael Jones: Hi, Just a quick heads up, embarrassingly I missed this update back in Dec 2009, but it is presumably the best way of getting your Sphinx stuff on to github-pages without their Jekyll code ignoring the

Re: [sphinx-dev] Sorted Glossary with german umlauts

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 15.12.2010 10:56, schrieb Jan Ulrich Hasecke: Hi, I have a sorted glossary with: .. glossary:: :sorted: But the german umlauts äöü are not sorted after a, o and u as I would expect it, but after z. Is there a way to configure

Re: [sphinx-dev] domain supported in literalinclude's pyobject

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 18.12.2010 20:15, schrieb Jean-Daniel: Hello, I am a big fan of literalinclude and especially its pyobject option [1]. For those not familiar with, this extract an object from a Python source file to display the formatted source code. Before

Re: [sphinx-dev] Re: unimpressed with latex output

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 17.12.2010 21:42, schrieb Michael P. Soulier: On 17/12/10 Guenter Milde said: Yes. At least, this limitation should be documented. Ideally the parser should halt before passing it to latex. This should now be handled a little more

Re: [sphinx-dev] Segmentation fault with import scipy.signal

2011-01-05 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 05.01.2011 17:29, schrieb LaurenP: Hi, I'm trying to use Sphinx to automatically generate documentation for a python project. One of the modules requires the scipy.signal package, which I try to import using the following: import scipy.signal

[sphinx-dev] Sphinx 1.0.6 released

2011-01-04 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi all, I'm happy to announce the release of Sphinx 1.0.6, a bug-fix release in the 1.0 series, fixing a number of bugs and regressions in the 1.0 line of releases. What is it? === Sphinx is a tool that makes it easy to create intelligent

Re: [sphinx-dev] Enumerated Lists not rendered

2011-01-02 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 02.01.2011 10:31, schrieb beberlei: Hello everyone, I am running into slight problems with enumerated lists. My rst file is rendered correctly by Github

Re: [sphinx-dev] Enumerated Lists not rendered

2011-01-02 Thread Georg Brandl
!! Oversight by myself, thanks for pointing at the obvious i've been missing for hours now :-) On Sun, 02 Jan 2011 10:56:51 +0100 Georg Brandl ge...@python.org wrote: Am 02.01.2011 10:31, schrieb beberlei: Hello everyone, I am running into slight problems with enumerated lists. My rst

Re: [sphinx-dev] Including RST files from arbitrary directories

2011-01-02 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 02.01.2011 11:57, schrieb Pavel Solin: Hi, I have Sphinx docs for my project in a directory /home/pavel/repos/hermes/doc/. I tried to move a file /home/pavel/repos/hermes/doc/src/hermes2d/tutorial-1/mesh.rst to another location

Re: [sphinx-dev] Re: cpp domain: problems handling short type

2010-12-29 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Thanks Akira, this is now fixed with rev 6a2b85e5591d. Georg Am 28.12.2010 15:44, schrieb Akira Kitada: Forgot to mention this. short cannot prefix short, so I think _modifiers['short'] should be fixed, too. On Tue, Dec 28, 2010 at 11:39 PM,

Re: [sphinx-dev] Sphinx crashes python

2010-12-29 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 27.12.2010 20:15, schrieb Bill Bedford: Since upgrading to Mac OS X 10.6 I have not been able to run Sphinx. the error is:- york:Mousa admin$ make html sphinx-build -b html -d build/doctrees source build/html Fatal Python error:

Re: [sphinx-dev] Short syntax for a cross-file reference?

2010-12-29 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 29.12.2010 15:36, schrieb Victor Stinner: Hi, I started with an unique document written in reST format. I used `reference name`_ which was replaced with reference name which is a link to a section with has a different name. After switching to

Re: [sphinx-dev] Where's the documentation for stuff like :mod:?

2010-12-28 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 26.12.2010 15:03, schrieb cool-RR: On Sun, Dec 26, 2010 at 1:43 PM, Ramiro Morales cra...@gmail.com mailto:cra...@gmail.com wrote: On Sun, Dec 26, 2010 at 8:06 AM, cool-RR ram.rac...@gmail.com mailto:ram.rac...@gmail.com wrote:

Re: [sphinx-dev] Use the ifconfig extension and include a section in the code

2010-12-11 Thread Georg Brandl
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 11.12.2010 02:50, schrieb Stéphane Wirtel: Hi all, .. ifconfig:: technical It's just a test -- docutils.paragraph This section won't be included why ? -- docutils.section === I

  1   2   3   4   5   6   7   >