Where can I find instructions on how to specify targets for :ref:s and :term:s in numpy, scipy, and matplotlib? I have a Gist with a handful of intersphinx mappings, which now includes all of numpy, scipy and matplotlib. You should be able to use these entries directly in intersphinx_mapping, within your conf.py. If anyone has … Read more
You don’t need to add labels. In order to refer to a Python class, method, or other documented object, use the markup provided by the Python domain. For example, the following defines a cross-reference to the mymethod method: :py:meth:`mymodule.MyClass.mymethod` Or even simpler (since the Python domain is the default): :meth:`mymodule.MyClass.mymethod` The documentation of TextWrapper.wrap that … Read more
To create links between different reStructuredText (.rst) files you can use the inline markup provided by sphinx. See the documentation under the heading Cross-referencing documents on top of the file you define its label .. _my-reference-label: then you can link to it from other documents using :ref:`my-reference-label`. I do not believe you need to use … Read more
If you only want to ..include:: a document in another document, without having it appear in any toctree. Add :orphan: to the top of your document to get rid of the warning. This is a File-wide metadata option. Read more from the Sphinx documentation.
Unfortunately, variables (and constants) do not have docstrings. After all, the variable is just a name for an integer, and you wouldn’t want to attach a docstring to the number 1 the way you would to a function or class object. If you look at almost any module in the stdlib, like pickle, you will … Read more
This construct: Here you have |optparse.OptionParser|_. .. |optparse.OptionParser| replace:: “optparse.OptionParser“ documentation .. _optparse.OptionParser: http://docs.python.org/library/optparse.html produces this HTML (some linebreaks added): <p>Here you have <a class=”reference external” href=”http://docs.python.org/library/optparse.html”> <tt class=”docutils literal”><span class=”pre”>optparse.OptionParser</span></tt> documentation</a>. </p> I realize that this is not exactly what you asked for, but maybe it’s close enough. See also http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible.
The same thing happened to me! To fix it, go to the line in conf.py that says something like this: extensions = [‘sphinx.ext.todo’, ‘sphinx.ext.viewcode’] Yours will probably look different. Anyway, add ‘sphinx.ext.autodoc’ to the list. e.g. extensions = [‘sphinx.ext.todo’, ‘sphinx.ext.viewcode’, ‘sphinx.ext.autodoc’] If it was: extensions = [] then you’d change it to: extensions = [‘sphinx.ext.autodoc’] … Read more
The doxypy input filter allows you to use pretty much all of Doxygen’s formatting tags in a standard Python docstring format. I use it to document a large mixed C++ and Python game application framework, and it’s working well.
Make sure the nested list is indented to the same level as the text of the parent list (or three characters, whichever is greater), like this: 1. X a. U b. V c. W 2. Y 3. Z Then you’ll get the output you expected.
Yes, you can! In lieu of a symlink (which won’t work on Windows), create a stub document that has nothing in it but a .. include:: directive. I ran into this trying to link to a README file that was in the top of the source tree. I put the following in a file called … Read more