Hi all. First time poster.
Thanks to all involved in the new sphinx-apidoc script - it's really superb.
I would like to suggest a tweak of the --doc-header parameter. It currently
defaults to value 'Project', and it appends the text ' Modules' to its value
is. (so the effective displayed default is actually 'Project Modules')
I'd like my header to read 'API Reference', however if I specify
--doc-header=API\ Reference, then the resulting displayed header reads 'API
Reference Modules'.
Might I suggest modifying the parameter so that it doesn't append anything
to the user's specified value, and tweak the default to become 'Project
Modules' to compensate.
The downside of this, of course, is that existing users who are specifying a
value will no longer have the value ' Modules' appended to their header,
which will be unexpected for them. But on the other hand, this script has
not seen a release yet.
I have a small patch (below), but thought I'd mention this here to see if
I've misunderstood the intention of the parameter, before wielding a pull
request.
Best regards,
Jonathan Hartley
### my proposed patch below. I'll issue a pull request if people like this
idea ###
--- sphinx\apidoc.py 2011-02-28 23:11:52.968750000 +0000
+++
\python27\lib\site-packages\Sphinx-1.1pre_ce4bb37a1409dev_20110228-py2.7.egg\sphinx\apidoc.py
2011-03-02 09:52:52.500000000 +0000
@@ -107,7 +107,7 @@
"""
Create the module's index.
"""
- text = format_heading(1, '%s Modules' % opts.header)
+ text = format_heading(1, '%s' % opts.header)
text += '.. toctree::\n'
text += ' :maxdepth: %s\n\n' % opts.maxdepth
@@ -241,8 +241,8 @@
parser.add_option('-T', '--no-toc', action='store_true', dest='notoc',
help='Don\'t create the table of contents file')
parser.add_option('-H', '--doc-header', action='store', dest='header',
- help='Documentation Header (default: Project)',
- default='Project')
+ help='Documentation Header (default: Project
Modules)',
+ default='Project Modules')
parser.add_option('-s', '--suffix', action='store', dest='suffix',
help='file suffix (default: rst)', default='rst')
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
