[sphinx-dev] Parameters in docstrings

2011-12-02 Thread Dominique
Hello, I'm wondering if people have suggestions on the best way to format function/method docstrings so it's possible to get Sphinx's fancy formatting and yet retain nice and readable docstrings from the Python prompt. I'm especially interested in how to document the function/ method input "parame

Re: [sphinx-dev] Using if statements in conf.py

2011-12-02 Thread Ernesto Posse
On Fri, Dec 2, 2011 at 11:27 AM, Alastair Dent wrote: > Can I do something like the following in conf.py: You can but you'll have to use Python syntax (conf.py is a Python module), so instead of > if ifconf_product=’mini’ then > > exclude_patterns = ['interface/*.rst',’dialogs/*.rst’] > > elseif

[sphinx-dev] Custom error messages

2011-12-02 Thread vladris
Hi, I am working on a blogging engine/static website generator based on Sphinx (BTW, you can add http://vladris.bitbucket.org to the list of projects using Sphinx). I plan to release this as a package sometime next year. Most of the logic is implemented as Sphinx extensions. What I would like is t

[sphinx-dev] Using if statements in conf.py

2011-12-02 Thread Alastair Dent
Can I do something like the following in conf.py: if ifconf_product='mini' then exclude_patterns = ['interface/*.rst','dialogs/*.rst'] elseif ifconf_product='main' then exclude_patterns = ['mini-indexes.rst] endif I need to exclude specific files for some builds an