Hi!
I'm using Sphinx's autodoc feature to document my API. For example::
DEFAULT_OPTION = 'default'
def do_something(msg, option=DEFAULT_OPTION):
print msg
The generated documentation now shows the following signature:
do_something(msg, option='default')
How can I tell
2011/8/31 Sebastian Rahlf ba...@rotekroete.de:
Hi!
I'm using Sphinx's autodoc feature to document my API. For example::
DEFAULT_OPTION = 'default'
def do_something(msg, option=DEFAULT_OPTION):
print msg
The generated documentation now shows the following signature:
On 2011-08-23, Gaël Varoquaux wrote:
I have a biggish document written in Sphinx (yeah go go go Sphinx!):
http://scipy-lectures.github.com/
It has 'parts', and chapters below them, as you can see from the above page.
So far the parts where just implemented as an extra layer of headers. The
Hi!
In some cases, when I make syntax mistake in reST source and when
there is a non-ascii character around, I get stacktrace instead of
helpful message telling me where is the mistake. It's quite hard to
track down such mistakes.
One example is when I forget empty line after directive, for
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 forget to
also upload those new copies of picture files and so I get broken
image references
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 1.0.7 if that is important.
.. js:attribute:: FOO
This does something
..
On Wed, Aug 31, 2011 at 3:38 PM, Aivar aivar.anna...@gmail.com wrote:
Hi!
In some cases, when I make syntax mistake in reST source and when
there is a non-ascii character around, I get stacktrace instead of
helpful message telling me where is the mistake. It's quite hard to
track down such
