Top "Python-sphinx" questions

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation.

How to correctly include other ReST-files in a sphinx-project?

My hand-written documentation/user-guide (written in ReStructuredText with sphinx) has become quite big so I started organize my .rst-files in …

python-sphinx restructuredtext
How to make an internal link to a heading in sphinx restructuredtext without creating arbitrary labels?

I have a document with many headings and sub-headings. Further into the text I want to link back to one …

python-sphinx restructuredtext
How to include the toctree in the sidebar of each page

I'm generating html documentation in Sphinx. How do I modify the sidebar for each of the html pages in my …

python-sphinx sidebar toctree
How to specify different return types in python docstring

I'm currently writing documentation for my python package using Sphinx and the autodoc plugin. For a function return value I …

python python-sphinx docstring autodoc
Sphinx doesn't find Python packages when using autodoc

I'm trying to create documentation for test Python project before doing it for the real project. My system : Win7 64 bit, …

python python-sphinx sphinx-apidoc
sphinx, restructuredtext: set color for a single word

Is there a way to set the color of single words (or characters) in sphinx? I'm pretty sure there should …

html python-sphinx restructuredtext
How to document an exception using Sphinx?

I can't seem to figure out how to document exceptions using Sphinx. I've tried the following: def some_funct(): """ :raises: …

python exception python-sphinx
Include my markdown README into Sphinx

I would like to include my project's README.md into my Sphinx documentation like in Can sphinx link to documents …

python markdown python-sphinx restructuredtext
Multi-line description of a parameter description in python docstring

So, reStructuredText is the recommended way for Python code documentation, if you try hard enough, you can find in the …

python coding-style python-sphinx restructuredtext docstring
How to include a local table of contents into Sphinx doc?

How to include a local table of contents into Sphinx doc? I tried .. toc:: But that doesn't seem to have …

python python-sphinx restructuredtext tableofcontents