Stack Overflow
Stack Overflow

Questions tagged [python-sphinx]

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation. Sphinx is especially suitable for Python documentation, but it is a general-purpose tool that can be used to document anything.

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well.

Sphinx is under constant development. The following features are present, work fine and can be seen “in action” in the Python documentation:

  • Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text.

  • Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information.

  • Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children.

  • Automatic indices: general index as well as a module index.

  • Code handling: automatic highlighting using the Pygments highlighter.

  • Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more.

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

See also:

3663 questions
2
votes
2 answers

Including source in Sphinx documentation

I am trying to use Sphinx to document a Python project of mine, but I am struggling with the differences between this tool and the usual tools like JavaDoc which are meant to document an API. Of course I see that Sphinx has many more uses than…
Andrea
  • 20,253
  • 23
  • 114
  • 183
2
votes
0 answers

Applying CSS classes to table rows with Sphinx and reStructuredText

We have a website that is generated using Sphinx and reStructuredText. Albeit not ideal (I have inherited this code), it's something that so far has worked and serves the purpose. We're trying to extend it slightly and one request was to highlight…
Samuele Mattiuzzo
  • 10,760
  • 5
  • 39
  • 63
2
votes
1 answer

toctree dropdown menu

I want to get a dropdown menu when listing pages in Sphinx. I am using toctree. But when this list appears, all the subsections also appear in the list. Is there a way to either: Get a dropdown menu or Not show the subsections
Wouter
  • 477
  • 2
  • 6
  • 8
2
votes
0 answers

Using tags/keywords in Sphinx/Jinja to create a page which contains a list of links to all other pages containing said tag/keyword

OK, I feel like this should be explained in some obvious place but I have searched and found nothing (and I always found an answer for my previous 999 problems, so normally I am not bad at searching). Basically, I am making a manual for my physical…
bazzwold
  • 21
  • 4
2
votes
1 answer

sphinx not able to find sphinx_rtd_theme

I'm newbe of Sphinx, I tried to use html_theme = 'sphinx_rtd_theme' in conf.py but I get message below when I run "make html" : sphinx_rtd_theme is no longer a hard dependency since version 1.4.0. Please install it manually.(pip install…
Edwin Lai
  • 359
  • 1
  • 3
  • 8
2
votes
0 answers

python sphinx error: make_toctree() got an unexpected keyword argument 'titles_only'

I've been trying to build the documentation for a python project using Sphinx with the rtd theme, and have encountered the following error: make_toctree() got an unexpected keyword argument 'titles_only' As far as I can tell, this error isn't…
MRule
  • 529
  • 1
  • 6
  • 18
2
votes
0 answers

Sphinx doesn't parse rst docstrings correctly

So I've been trying to make some documentation for my project. I found Sphinx, and it looked great, so I chose that. Now, I'm trying to use its autodoc function, however, it doesn't work properly. At first, I thought that it was because my…
Plutoberth
  • 709
  • 7
  • 19
2
votes
2 answers

How to set a BASE URL for sphinx documentation?

I have created documentation for my project using sphinx. the current endpoint for my documentation is /. My question is, how can i make my documentation follow a docs/ pattern? EX. /docs/index.html in my project's config.py i…
juan_code18
  • 233
  • 6
  • 15
2
votes
0 answers

HTML header and footer repeated nicely on every printed page - REVISITED

I know this subject has been discussed many times, but I have failed to find a satisfying answer. My problem is: I want a nice header and footer (with pictures etc.) on every page when I print my page. I have tried using the running() positions in…
mpnowacki
  • 33
  • 5
2
votes
1 answer

Sphinx Documentation with different separated subjects

I'm trying to build kind of a dashboard in the index with one tile per subject. Each subject will later have its own folder in source with it's own md files. I want each subject to be disconnected to the others. So the previous button should no go…
vinni
  • 633
  • 2
  • 8
  • 32
2
votes
1 answer

Sphinx doesn't find modules despite em being in $PATH

I get no errors during make html or sphinx-apidoc. But after sphinx-build -b html ./rst/ ./html/ I get: WARNING: autodoc: failed to import module u'mcp.mcp.ann_mcp'; the following exception was raised: No module named mcp.ann_mcp In…
NeuroDad
  • 21
  • 2
2
votes
0 answers

How to make a Sphinx project on Jython?

I am trying to make a Sphinx documentation on Jython. I was able to install sphinx on the installed jython, but when I run the sphinx quickstart program I get: C:\jython2.7.0\bin>sphinx-quickstart.exe Traceback (most recent call last): File…
lubaaaaaa
  • 41
  • 2
2
votes
1 answer

Is there an intersphinx mapping to wxpython?

I would like to add intersphinx mappings to the documentation of my project. It worked fine with python, but I can't find a mapping to wxpython. Can anybody help? Thanks in advance
Humbalan
  • 677
  • 3
  • 14
2
votes
1 answer

How to set an extension's configuration value in Sphinx

I'm trying to use the autosectionlabel_prefix_document config value in the autosectionlabel extension described here. I've loaded the extension in conf.py, and it works fine. Currently, I've tried adding the line: autosectionlabel_prefix_document =…
R. Tucker
  • 21
  • 5
2
votes
2 answers

c++ doxygen + breathe tables

I have a large c++ project documented with doxygen. I want to use breathe to make nicer manuals. The in-source documentation often contain tables such as this: /** * @var somevar * @brief some variable * @defgroup somegroup Some Group * @details…
user1283043
  • 190
  • 1
  • 1
  • 8
1 2 3
…
99
100