Hi all,
I made a little change to apidoc.py which I'd like to share here. I
didn't like the fact that apidoc generates, in the main module of a
package, first the sections "Submodules" and "Subpackages" and only then
the "Module contents". I prefer to have the module contents (without
section header) at the beginning of the file, followed only then by the
packages.
In file apidoc.py, lines 91ff, function create_package_file, I moved the
following two lines towards the beginning (just after the ``text =
format_heading(1, '%s package' ...`` line::
# text += format_heading(2, 'Module contents')
text += format_directive(subroot, master_package)
and after these lines I insert another blank line to the output::
text += '\n\n'
Here is an example output generated using these changes:
http://lino-framework.org/api/lino.utils.html
For me this way is much better. I don't imagine how somebody might
prefer it the other way. But since this part of the apidoc output cannot
easily be made configurable, we need to discuss here whether this new
format might be acceptable for everybody. I must say that I use the
`--separate` option, and that I don't claim to have made very deep
investigations.
What do other people think about this?
Luc
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/groups/opt_out.
