The Sphinx Contrib project also seems to have an HTTP Domain package for documenting RESTful HTTP APIs. You can find its documentation on the Python packages site. I can’t speak to its fitness: I’m only just starting to look into Sphinx, and I have a need to document RESTful APIs as well, and noticed this … Read more
You can now (as of version 0.6) use :exclude-members: to exclude specific members from the documentation: The directives supporting member documentation also have a exclude-members option that can be used to exclude single member names from documentation, if all members are to be documented. New in version 0.6. Source: http://www.sphinx-doc.org/en/stable/ext/autodoc.html In your specific case, you … Read more
You can use a backslash for line continuation: def some_funct(): “”” :raises ExceptionType: Some multi-line \ exception description. “”” Update: Indenting seems to work instead of escaping the newline: def some_funct(): “”” :raises ExceptionType: Some multi-line exception description. “””
if you are using sphinx 1.1 or above, from the sphinx documentation site at http://www.sphinx-doc.org/en/master/ext/autodoc.html, :special-members: :private-members:
Are there .rst files in your Sphinx project whose content you don’t want in the output? Use the exclude_patterns configuration variable. No output (and no warning messages) will be generated for files matching the specified patterns. See http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patterns. Are there .rst files in your Sphinx project that are not part of any toctree but whose … Read more
You can change add_module_names to False in the file conf.py: # If true, the current module name will be prepended to all description # unit titles (such as .. function::). add_module_names = False Then foo.bar.my_function() will display as my_function().
Aha, last ditch effort on a little googling turned up this example, scroll down to the bottom. Apparently a setup() function in conf.py will get called with the app. I was able to define the following at the bottom of my conf.py: def maybe_skip_member(app, what, name, obj, skip, options): print app, what, name, obj, skip, … Read more
There is no way to tell Sphinx to exclude some imports. When using autodoc, all documented modules must be cleanly importable. You might be able to work around the problem by doing some mocking. Here is an article describing the solution to a problem that seems quite similar to yours: http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/. Here is a small … Read more
Sadly I don’t think rst offers that ability… the table styling options are rather limited. That said, if you’re rendering to HTML, you could add a custom stylesheet with a css rule such as: table.right-align-right-col td:last-child { text-align: right } and then add the directive: .. rst-class:: right-align-right-col right above your table in the rst … Read more
Turns out the answer was hiding in plain sight on Sphinx’s TOC tree page: The special entry name self stands for the document containing the toctree directive. This is useful if you want to generate a “sitemap” from the toctree. Adding self to the TOC tree did the trick perfectly! And if you place it … Read more