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.
python-sphinx
3,794
questions
0
votes
0
answers
10
views
Invalid anchor to a C++ member in Doxygen
I am trying to link to a C++ member variable in a RST document processed by Sphinx (let's call it X.rst). Another document (let's call it Y.rst) includes the Doxygen docs for the class in question:
.. ...
- 148
0
votes
0
answers
7
views
MyST implicit references work locally but not on Read The Docs
I am using Sphinx to build my documentation and I parse markdown files with MyST.
I used implicit text to link to different references, for example [](#my-heading) or [](#MyPyClass). This works fine ...
- 2,854
0
votes
1
answer
16
views
Add additional class to Interpreted Text Roles in Sphinx
What I am trying to achieve is to (manually) insert a html-class to certain elements using the sphinx' python domain
For example I have this string:
Lore Ipsum :py:mod:`dataclasses`
Which results in:
...
- 2,854
-2
votes
1
answer
29
views
Sphinx RTD Theme improperly nesting subheadings
I have a single index.rst file that has the contents of my README.rst included using the .. include:: directive. When rendering this using make latexpdf or using the .. contents:: directive in html, ...
0
votes
1
answer
46
views
How to programmatically generate some documentation from Python dictionary and insert it into .rst file using Sphinx
I am writing a configuration tool that automates the deployment of some monitoring dashboards. Each dashboard has a written description that is available in the tool, and can be found in the deployed ...
- 2,432
0
votes
0
answers
50
views
Sphinx autoflask only makes one page for all the endpoints
I've inherited a project and am using Sphinx for the first time.
I've got a app.py that has all my api endpoints and when you make documentation you have all the api.add_resources wrapped in a ...
- 40
0
votes
0
answers
41
views
How to order class attributes before methods with autoclass in sphinx-docs?
When generating the class docs using .. autoclass:: I tried with the flag autodoc_member_order = 'groupwise'. However, the methods are coming above class attributes.
Any suggestions on how to order ...
-3
votes
0
answers
29
views
Virtual Environment Using Wrong Python Packages
I created a virtual environment (as root) in order to use Python3.11 with Sphinx7.3.7 (this being a site-package for Python3.11 within the created virtual environment lib directory). This works as ...
- 99
0
votes
0
answers
32
views
Sphinx + rst2pdf python variables from conf.py
Trying to use sphinx #Version in a rst2pdf yml style to add it to each page of the pdf.
# conf.py
version = str(datetime.date.today())
rst_epilog = """
.. |ProjectVersion| replace:: ...
- 2,702
0
votes
0
answers
25
views
Sphinx autodoc: avoiding duplicates when mixing automatic and explicit members of automodule
I'm trying to organize the contents of a module under subsections. I was surprised to see that section headers are allowed within an automodule directive, which works well for my purposes. I'm ...
- 1,423
0
votes
1
answer
40
views
How to Resolve 'ascii' Codec Can't Decode Error When Generating Confluence Document with LaTeX Formulas Containing Cyrillic Characters Using Sphinx?
I am trying to generate a document for Confluence. The source data is an RST document containing LaTeX formulas, which sometimes include Cyrillic characters.
Here is my conf.py configuration file:
...
- 55
0
votes
0
answers
23
views
Sphinx autodoc - Recursion error: maximum recursion depth exceeded
I am trying update our stravalib documentatio. We use Sphinx / pydata_sphinx_theme +
the native sphinx.autodoc extension combined with autodoc-pydantic for JSON representations.
Upon building the ...
- 717
0
votes
0
answers
34
views
How to hide toctree navbar children with sphinx restructured text (rst)?
I have a 1-pager I'm linking to, but the h2 (---) is redundantly showing. Since it's only a single page, it looks funny and would really like to hide this.
Setup
conf.py
html_theme = '...
- 988
0
votes
1
answer
37
views
Selectively including private member functions in sphinx documentation
I want to autogenerate documentation for a python project. I managed to get a barebones pipeline working with sphinx, but the output currently includes literally everything and I want to be more ...
- 1,338
0
votes
1
answer
39
views
Building TOC in sphinx that reflects project folder structure
I want to autogenerate documentation for a python project. I managed to get a barebones pipeline working with sphinx, but the output is not very pretty and I would appreciate some guidance on how to ...
- 1,338