Top "Python-sphinx" questions

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

How to make sphinx look for modules in virtualenv while building html?

I want to build html docs using a virtualenv instead of the native environment on my machine. I've entered the …

virtualenv python-sphinx
How can I make Python/Sphinx document object attributes only declared in __init__?

I have Python classes with object attributes which are only declared as part of running the constructor, like so: class …

python attributes python-sphinx docstring
How to properly write cross-references to external documentation with intersphinx?

I'm trying to add cross-references to external API into my documentation but I'm facing three different behaviors. I am using …

python opencv documentation python-sphinx autodoc
How to document one file with functions?

I have a python file with functions (lib.py), without classes. Each function has the following style: def fnc1(a,…

python python-sphinx sphinx-apidoc
Sphinx section numbering for more than level 3 headings: .. sectnum::

I am using Sphinx to generate pdf files from rst files. Sphinx automatically generates section numbers up to level 3 headings, …

python-sphinx restructuredtext sections toctree
sphinx customization of latexpdf output?

Just curious if anyone knows how to customize the sphinx output when using the latexpdf target? I've seen lots of …

latex pdflatex python-sphinx
Combining Sphinx documentation from multiple subprojects: Handling indices, syncing configuration, etc

We have a multi-module project documented with the (excellent) Sphinx. Our setup is not unlike one described on the mailing …

python python-sphinx
Sphinx: force rebuild of html, including autodoc

Currently, whenever I run sphinx-build, only when there are changes to the source files are the inline docstrings picked up …

python python-sphinx sphinx-apidoc
Format text in a link in reStructuredText

How do you format text within a denoted link in reStructuredText? Specifically, I wish to generate the following HTML from …

python-sphinx restructuredtext
Sphinx inline code highlight

I use Sphinx to make a website that contains code samples. I'm successful using the .. code-block directive to get syntax …

css syntax-highlighting python-sphinx restructuredtext pygments