Top "Python-sphinx" questions

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

How to document Python code using Doxygen

I like Doxygen to create documentation of C or PHP code. I have an upcoming Python project and I think …

python documentation python-sphinx doxygen docstring
sphinx-build fail - autodoc can't import/find module

I'm trying to get started with Sphinx and seem to have relentless problems. Command: docs/sphinx-quickstart I answer all the …

python python-sphinx autodoc
Adding a cross-reference to a subheading or anchor in another page

How to insert a cross-reference in a reST/Sphinx page to either a sub-header or anchor in another page in …

python-sphinx restructuredtext sections cross-reference
Using sphinx with Markdown instead of RST

I hate RST but love sphinx. Is there a way that sphinx reads markdown instead of reStructuredText?

python markdown python-sphinx
Sphinx autodoc is not automatic enough

I'm trying to use Sphinx to document a 5,000+ line project in Python. It has about 7 base modules. As far as …

python python-sphinx autodoc
Link to class method in python docstring

I want to add a link to a method in my class from within the docstring of another method of …

python python-sphinx spyder
Relative imports require the 'package' argument

I want to use Sphinx so it can automatically generate a pydoc for my python code but I'm getting an …

python django python-sphinx pydoc
How to use Sphinx's autodoc to document a class's __init__(self) method?

Sphinx doesn't generate docs for __init__(self) by default. I have tried the following: .. automodule:: mymodule :members: and ..autoclass:: MyClass :…

python python-sphinx autodoc
What is the correct way to document a **kwargs parameter?

I'm using sphinx and the autodoc plugin to generate API documentation for my Python modules. Whilst I can see how …

python python-sphinx autodoc
How to preserve line breaks when generating python docs using sphinx

I am using Sphinx for generating docs for a python project. The output html is not preserving the line breaks …

python python-sphinx