Issues

Issue #759 open

Keeping original signatures for functions/methods

Sebastian Rahlf
created an issue

I'm using Sphinx's autodoc feature to document my API.

Example: {{{

!python

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') }}}

It would be nice if there was a way to tell Sphinx to keep the name of the constant value, i.e.

{{{ do_something(msg, option=DEFAULT_OPTION) }}}

At the moment the only alternative is to write all signature by hand again.

Comments (2)

  1. Log in to comment