3,847 questions
- Bountied 0
- Unanswered
- Frequent
- Score
- Trending
- Week
- Month
- Unanswered (my tags)
-5
votes
0
answers
76
views
How to reference to a specific item in a list [duplicate]
I have this:
1. First element
.. _first-element:
1. Second element
1. Third element
:ref:`first-element`
It does not work with sphinx-doc
0
votes
0
answers
64
views
Wikipedia returns 403 when using sphinx linkcheck to check for broken links
We use sphinx linkcheck to make sure that our docs do not contain broken links, but Wikipedia has started returning a 403, assuming that our CI is a robot. Fair enough, it is a robot, so has anyone ...
0
votes
1
answer
104
views
Sphinx-apidoc and 'src' layout
I want to document my code using sphinx but I'm using the 'src' layout for my structure. Below is an example:
products
├── src
│ └── products
│ ├── agreport.py
│ ├── cci.py
│ ├── ...
0
votes
1
answer
94
views
How can I make sphinx latex builder add alt texts to sphinxincludegraphics?
I am tasked creating accessible documentation (PDF UA) from rst.
The idea was to use DocumentMetadata to enable tagging in general with something like a caption or :alt: to achieve this. However I ...
0
votes
1
answer
62
views
Sphinx sphinx-apidoc generated module titles are too long (full package path). How can I shorten them?
I am generating python API documentation using Sphinx and sphinx-apidoc with sphinx-rtd-theme
The problem is:
The page titles and ToC entries for modules/packages always show the full import path,
e....
Advice
0
votes
2
replies
57
views
Have sphinx avoid naming `index.html` unnecessarily in its links?
Our project's sphinx-generated HTML includes many links to index.html files (e.g., path/to/index.html) rather than linking to the directories themselves (e.g., path/to/). Is there an option or best ...
3
votes
1
answer
91
views
Clarification on reStructuredText directive indentation rules
I'm working with Sphinx to transform reStructuredText (rst) documents to HTML.
I've read documentation (primarily Sphinx's rST primer and Docutils rST documentation) and need clarification on the ...
2
votes
2
answers
129
views
myst_parser WARNING: 'myst' cross-reference target not found
When I compile my docs with Sphinx and a Markdown file, using myst_parser, I get a warning for cross-reference not found, even if after compilation links works well.
test_page.md:
# test page
[click ...
0
votes
0
answers
88
views
How to correct 3rd party sphinx ambiguous cross-reference warnings?
I'm trying to document a variety of classes that use scikit-learn bases BaseEstimator and TransformerMixin. Sphinx builds with a warning that,
/home/jake/github/proj/pkg/__init__.py:docstring of
...
1
vote
0
answers
44
views
Using Sphinx autosummary to generate documentation for class instances stored as attributes during instantiation of another class
I have a class called WebAPI that instantiates and stores a UserEndpoints object inside its constructor:
# /src/minim/api/spotify/_core.py
... # other imports
from .._shared import OAuth2API
from ....
1
vote
0
answers
63
views
How should I install CUDA dependencies in readthedocs build with apidoc autodoc
I have a python project which uses readthedocs and its apidoc/autodoc to build API documents automatically. The project uses a third-party tool that can only be installed from source like this: pip ...
1
vote
2
answers
83
views
Sphinx getting a <ul> with a class
I am quite new to Sphinx.
My code:
.. _ahn-kwon-14:
* A----. 2014, J. Number Theory, 145, 433--473.
It gets translated into
<ul class="simple" id="ahn-kwon-14">
<li>&...
1
vote
1
answer
109
views
How to update the table of contents (toctree) in a Sphinx extension?
I am writing a sphinx extension where I want to filter sections dependent on parameters provided to the sphinx-build.
In the first approach I just removed certain sections that where somehow ...
3
votes
1
answer
90
views
Is there a way to generate superscripts from docstrings?
I have a GitHub Actions workflow setup with Sphinx and some extensions for document generation.
I was wondering if there is any way to set up a docstring such that Sphinx will generate in superscript, ...
1
vote
1
answer
69
views
Defining a Sphinx MathJax macro with arguments throws error "MathJax: Invalid option"
I'm running Sphinx 4.5.0 in Python 3.10 and trying to write a MathJax macro that takes parameters. I've found examples that show how to do this (example 1 mathjax3_config)
, but when I copy them to ...