Top "Python-sphinx" questions

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

How can I configure Sphinx to conditionally exclude some pages?

When generating documentation using Sphinx, I would like to be able to generate two versions of my documentation: one including …

python documentation python-sphinx
using Sphinx's sphinx-apidoc utility to autogenerate documentation from python code

I am wondering what the commenting format is in order to have self-documenting code using Sphinx's sphinx-apidoc utility. I am …

python python-sphinx sphinx-apidoc
What is the relationship between docutils and Sphinx?

There seems to be a plethora of documentation tools for Python. Another one that I've run across is epydoc. It …

python documentation-generation python-sphinx epydoc
Use Sphinx autosummary recursively to generate API documentation

I want to use Sphinx's autosummary extension and templates to generate API docs recursively from docstrings. I want separate pages …

python jinja2 python-sphinx restructuredtext toctree
Is it possible to override Sphinx autodoc for specific functions?

I'm using Sphinx's autodoc plugin to automatically document a set of modules. I have a function that accepts *args, and …

python python-sphinx autodoc
External Relative Link in Sphinx toctree directive

I'm using Sphinx to build my documentation. I'm using other tool for API reference. I have my docs in a …

python-sphinx toctree
some online tool or automation plugin for sublimetext for generating sphinx RST tables

I am using sphinx for documentation. I would like to easily genearate based e.g on CSV file or copy-paste …

python-sphinx restructuredtext
How can I add a custom footer to Sphinx documentation? (reStructuredText)

If I have some documentation, like for example Galleria's documentation, how can I set it up so that when I …

linux unix makefile restructuredtext python-sphinx
Is there a Sphinx reST Python docstring field for yields?

I'm trying to use reST-style docstrings, i.e. def foo(bar): """a method that takes a bar :param bar: a …

python python-sphinx restructuredtext
How to specify multiple return types in a function docstring in Python?

I am aware of the syntax used to build a docstring for Google style such as: def function_with_types_…

python python-sphinx return-type docstring sphinx-napoleon