Is there a way in rst to have automatic header numbering ? That is something like:
#. Some Section
===============
...
#. Some Subsection
------------------
...
#. Another Subsection
---------------------
...
#. Another Section
==================
...
that would be rendered as:
...
...
...
...
According to the docutils manual, you can use the sectnum directive: http://docutils.sourceforge.net/0.7/docs/ref/rst/directives.html#automatic-section-numbering
So you can add something like this in the very first line(s):
.. sectnum::
HTH
I ve been documenting a software package using Sphinx and reStructuredText. Within my documents, there are some long code snippets. I want to be able to have them hidden as default, with a little "...
Is there a way in rst to have automatic header numbering ? That is something like: #. Some Section =============== ... #. Some Subsection ------------------ ... #. Another Subsection -----------------...
I prefer to document each parameter (as needed) on the same line where I declare the parameter in order to apply D.R.Y. If I have code like this: def foo( flab_nickers, # a series of under ...
Instead of a blog/cms, I d like to have a static html-based site with a few (rarely updated) pages. I figure the simplest way to update them is to keep the sources in a format like ReST, and compile ...
Is Sphinx, is there way to automatically link text like #112 or r1023 to the corresponding tickets/changesets in Trac? For eg: #112 -> http://mytracsite/tickets/112 r1023 -> http://mytracsite/...
Related: How to store lightweight formatting (Textile, Markdown) in database? I want to store comment formatting in some markup language in our DB. However, we want to allow multiple formatting ...
I need a documentation system for a PHP project and I wanted it to be able to integrate external documentation (use cases, project scope etc.) with the documentation generated from code comments. It ...
I m using Django s markup package to transform restructuredText into html. Is there a way to customize the HTML writer to add a class attribute to each <p> tag? I could use the class directive ...