I'm writing reference documentation for my modules with many functions. I
am breaking the code up into sections as below, but it is feeling terribly
repetetive.
Is there a cleaner method for this style of documentation? I'm open to any
sort of suggestions or examples. What I'm really hoping for is a way to
remove the list of function names from the "autosummary" and have use the
list of functions I've manually listed. Is this the job for a Sphinx
extension?
.. module:: CoreExceptionHandler
Handling Errors
---------------
.. autosummary::
:nosignatures:
HandleException
GetLastExceptionString
GetLastStackTraceString
.. autofunction:: HandleException
.. autofunction:: GetLastExceptionString
.. autofunction:: GetLastStackTraceString
Debugging and Testing
---------------------
.. autosummary::
:nosignatures:
GetLogRoot
SetLogRoot
.. autofunction:: SetLogRoot
.. autofunction:: GetLogRoot
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To view this discussion on the web visit
https://groups.google.com/d/msg/sphinx-dev/-/XiXKMf0v1jAJ.
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.
