586 questions
-2
votes
0
answers
34
views
ReadTheDocs deploy key issue [closed]
ReadTheDocs requires deploy keys to be read only.
I'm getting a message that for two of my projects, the deploy keys are read/write.
For each project, the message says to delete the existing read/...
1
vote
0
answers
59
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
0
votes
0
answers
97
views
How to manually trigger Github Pull Request build
We have Pull Requests Builds enabled for the Ceph project in settings. This usually works fine. We also have a Github workflow to enable developers to retrigger a build for a pull request by ...
1
vote
0
answers
118
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
2
votes
0
answers
82
views
Pass artifact from github actions to ReadTheDocs build
I am trying to speed up the Readthedocs build for a python project with executed docs. The project is a rust library with python bindings built by maturin. Installing rust and building the library ...
- 3,210
1
vote
0
answers
54
views
How to disable duplicate parameter documentation in Sphinx / ReadTheDocs theme
When documenting Python code using Sphinx (v8.2.3), the parameters of the class' initializer __init__(self, ...) are documented two times:
in the class' description
in the dunder init method
I ...
- 16.5k
0
votes
1
answer
81
views
Cannot reference aiohttp classes in my documentation
I am working on a project that uses aiohttp. I'm setting up my documentation using sphinx on ReadTheDocs.org.
I have set up the interpshinx extension in conf.py and configured the mapping as following:...
- 23
0
votes
1
answer
82
views
Images from README.md are not being parsed
This is my index.rst
.. include:: ../README.md
:parser: myst_parser.sphinx_
.. toctree::
:maxdepth: 1
README.rst
.. toctree::
:maxdepth: 1
:caption: Tutorial:
:glob:
notebook/*...
0
votes
1
answer
102
views
readthedocs: "ERROR Make sure the key name sphinx.output_dir is correct" (documentation build fails)
I am struggling to get my documentation built on readthedocs.
Locally, everything works fine, but there seems to be something wrong with my .readthedocs.yaml file:
version: 2
build:
os: ubuntu-22....
- 139
0
votes
1
answer
289
views
How do I fix autoapi.not_readable error that only occurs on readthedocs?
I am getting an error on every one of my package files when I try to build my documentation on readthedocs. The error is [autoapi.not_readable].
The most strange part of this is that my documentation ...
user23067825
0
votes
1
answer
174
views
How to reduce font size for a specific table in Sphinx with ReadTheDocs theme?
I am using Sphinx with the ReadTheDocs theme (sphinx_rtd_theme), and I need to reduce the font size of a specific table while keeping other tables unchanged.
I tried using:
.. list-table:: Issues &...
- 73
1
vote
2
answers
62
views
Pyparsing - documentation?
The docs at ReadTheDocs used to be downloadable as PDFs, HTML zips, etc. Those options don't seem to exist anymore. Where can I get - preferably HTML zips - documentation for off-line use?
Or, ...
- 5,472
0
votes
1
answer
85
views
readthedocs cannot find requirements.txt
.readthedocs.yaml:
python:
install:
- requirements: source/requirements.txt
in docs directory
source
├── _static
├── _templates
├── conf.py
├── hardware.rst
├── index.rst
...
- 1
0
votes
1
answer
73
views
.readthedocs.yaml : needs to stop after commands done
This is my .readthedocs.yaml script:
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
apt_packages:
...
- 426
-1
votes
1
answer
68
views
cd command does not work from .readthedocs.yaml [closed]
This my yaml file, https://gitlab.com/miroi/dirac-fork/-/blob/rtd_documentation/.readthedocs.yaml?ref_type=heads
and this is the output from documentation buildup : https://readthedocs.org/projects/...
- 426
