3,847 questions
0
votes
0
answers
60
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,806
1
vote
0
answers
39
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 ....
- 528
1
vote
0
answers
46
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 ...
- 2,337
1
vote
2
answers
69
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>&...
- 111
1
vote
1
answer
84
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 ...
- 41
2
votes
1
answer
71
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, ...
- 175
1
vote
1
answer
58
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 ...
- 83
1
vote
0
answers
123
views
The SQLAlchemy @hybrid_property decorator creates an exception in Sphinx autodoc and the property is not documented
I have a SQLAlchemy @hybrid_property like this:
@hybrid_property
def number_of_lightnings(self) -> int:
"""
Blah, blah, blah....
when I generate the docs with Sphinx I get ...
1
vote
0
answers
62
views
How to mention parameters in a docstring [duplicate]
I am already familiar with :param name: description. I am asking a different question.
There are contexts in which I want to mention (as opposed to describe) a function/method parameter within a ...
- 478
2
votes
0
answers
56
views
sphinxcontrib-bibtex and sphinx-multiversion
I have a strange bug when building our documentation using sphinxcontrib-bibtex and sphinx-multiversion.
In my docs/source/conf.py I have
from pathlib import Path
extensions = [
"...
- 1,897
1
vote
0
answers
68
views
Is it possible to combine some information written manually (including images) into the auto generated docs?
I have some auto generated documentation using Sphinx
I would like to overwrite one of the pages with a manually written page that includes additional images, which isn't possible in the autodoc from ...
- 169
2
votes
0
answers
38
views
How to resolve the URL to a class/function/method in a sphinx extension
Background
I'm designing a Sphinx extension called sphinx-uml that tries to improve sphinx-pyreverse. The goal is to output a navigable UML diagram (when you click a class/method/function, you go to ...
- 395
0
votes
1
answer
49
views
Code block partially highlighted in Sphinx
In my Sphinx documentation I have the following code-block:
.. code-block:: python
import logging
logging.getLogger('mymodule').setLevel(logging.INFO)
but when the documentation is rendered ...
- 963
1
vote
0
answers
101
views
readthedocs failing on maturin builds
I have a primary python project that has a dependency of another python lib which is a maturin wrapped rust crate.
My 'readthedocs' script is failing on the lib using maturin with:
Caused by:
...
- 8,185
1
vote
1
answer
66
views
How to add variable in versionadded admonition title
I have a variable defined in conf.py that holds the version and I use it everywhere else in my sphinx documentation with |version| with no issue. However it doesn't work for the versionadded ...
- 103