586 questions
Advice
0
votes
1
replies
23
views
Seeking clarification on cookies given to a user from a hosted RTD website
Apologies if this is clear to everyone else but me. Are any cookies placed onto a user's machine by a RTD-hosted site?
I read this blog post from 2016 which says:
We do record the number of ...
- 13
1
vote
0
answers
69
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
0
answers
161
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
169
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,205
2
votes
0
answers
100
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
62
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
91
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
91
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
114
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
374
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
225
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
68
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,470
0
votes
1
answer
94
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
75
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
75
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
0
votes
1
answer
81
views
ReadTheDocs redirect missing versions to latest
I know there is a way to write redirect rules in project settings, but I'm not sure if what I need is possible in any way.
I just want to have a redirect that only redirects missing/unknown versions ...
- 77
1
vote
1
answer
346
views
How can I make ReadTheDocs theme for Sphinx lay out function parameters nicely for mobile?
The ReadTheDocs theme for Sphinx is a particularly nice and easy to read theme. It works very well on decent width displays. Here's an example:
It also mostly also works very well on very narrow ...
- 10.2k
2
votes
1
answer
111
views
read-the-docs build has blank html for some pages
We use read-the-docs and sphinx to build documentation for a package hosted on GitHub. The documentation includes .ipynb files (Python notebooks) which are rendered as HTML on the readthedocs web page....
- 133
0
votes
1
answer
712
views
ReadTheDocs Sphinx: WARNING: Field list ends without a blank line; unexpected unindent
I'm documenting my Python package using Sphinx. But I've come across several warnings I have no idea, what to do about. All of them are occurring in my module-level docstrings, not inside of classes ...
- 3,007
0
votes
1
answer
417
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 ...
- 5,320
-2
votes
1
answer
157
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
123
views
Why does readthedocs require authorisation to write commits when connecting to github?
I'm trying to use readthedocs with a github repo that stores a Python project. When I try to connect it to my github profile, I am asked to authorise the following:
This application will be able to ...
- 844
2
votes
0
answers
126
views
Is there a way to minify/combine css/js sphinx-extension-assets from the _static directory to have fewer and smaller requests?
When building (readthe)docs with a sphinx-theme, most of the used extensions bring their own css and js files which are being loaded separately (e.g. copybutton.css/js, tabs.css/js, togglebutton.css/...
- 21
0
votes
1
answer
123
views
API reference section blank on readthedocs
I am trying to get documentation on the readthedocs for my package epspy (https://github.com/shikharmittal04/epspy.git). I can see all the sections on the documentation except for the API reference ...
- 41
1
vote
0
answers
104
views
Hide Attributes with sphinx-autodoc2
I have classes defined with the @dataclass decorator. This means that they look like this:
@dataclass
class myclass:
"""Some class
:param first_param: some description
:...
- 43k
3
votes
0
answers
169
views
Sphinx / read-the-docs stopped showing matplotlib plots from notebook documentation
I wonder if anyone could please help me with this issue:
I have a small library whose documentation is a mixture of .rst and jupyter notebook files. In the past, I just used nbsphinx to compile the ...
- 693
0
votes
0
answers
60
views
ReadTheDocs sphix build error: index.rst not found [duplicate]
I'm trying to build and publish documentation on ReadTheDocs from a github repo.
The build yields an error:
Running Sphinx v7.3.7
making output directory... done
WARNING: html_static_path entry '...
- 3,675
2
votes
1
answer
295
views
ReadTheDocs build doesn't produce an index file
While not building documentation that used to work just fine before recently a rebuild produced
Error
Your documentation did not generate an index.html at its root directory. This is required for ...
- 628
0
votes
1
answer
229
views
Read The Docs (Sphinx) PDF download functionality
Is there a known method to modify the default PDF download settings for Read The Docs?
Specifically I'm interested in:
Custom styling
Ability to download a single article/page/file (while retaining ...
0
votes
1
answer
95
views
ReadTheDocs: trigger build only for a given folder
I have a ReadTheDocs project set up with an integration/webhook so that it builds when the develop branch of my Github repo is updated.
The problem is that this triggers a build any time I push to the ...
- 43k
1
vote
0
answers
44
views
How to skip pbr version check in Python packages
I use pbr in my package. I also use readthedocs to host and generate the docs of the package.
pbr doesn't seem to have a way to skip the version checking when you add changes for the sake of ...
- 643
0
votes
1
answer
127
views
Read The Docs Build on GitHub Push not building - no error message
I've had a Build The Docs auto build which is triggered by a webhook from Git hub. It's worked before, but suddenly today is not working any more, and I'm not getting any obvious error messages (build ...
- 140
0
votes
0
answers
233
views
readthedocs build fails with `Sphinx version error`
readthedocs started to throw an error Sphinx version error during build, although there were no changes to the readthedocs configuration and dependencies are all pinned.
Here's the repository and a ...
- 358
0
votes
1
answer
694
views
How to use the README.md file as homepage for shpinx readthedocs
I have a README.md file which contains general overview of the package, and would like to add that file as main homepage to my documentation using spinx, can you please tell me how can I add it to my ...
- 306
1
vote
2
answers
449
views
How do I specify the plantuml version with ReadTheDocs?
I am trying to use PlantUML in my Sphinx project hosted on ReadTheDocs. I want to know how to specify the version of PlantUML to install because it's currently installing an older version, which doesn'...
- 61
1
vote
1
answer
364
views
How to specify a file that can be downloaded via ReadTheDocs with MkDocs
Presently, i am using https://pypi.org/project/mkdocs-with-pdf/
- with-pdf:
cover_subtitle: PDF created with mkdocs-with-pdf
# TODO: find a way to use $READTHEDOCS_OUTPUT and $...
- 11
0
votes
1
answer
264
views
Intersphinx Configuration Issues with Private GitHub Repositories on Read the Docs
I'm setting up Read the Docs for multiple projects with private GitHub repositories and facing issues with intersphinx configuration. My goal is to enable intersphinx references across these projects, ...
0
votes
1
answer
839
views
How to get link to readthedocs documentation to show up on github repo?
I have a github repo with documentation served on readthedocs (say, at https://myreponame.readthedocs.io/en/latest/). Webhooks are set up at github so with PRs or pushes, the hook is triggered. This ...
- 8,311
0
votes
1
answer
1k
views
ReadTheDocs Sphinx build failing due to version error
I've created a documentation for python library that I released last December.
https://monalysa.readthedocs.io/en/latest/
GitHub Repository: https://github.com/siva82kb/monalysa/tree/main
I've made ...
- 1,942
0
votes
1
answer
156
views
Custom PDFs are not generated in the ReadTheDocs flyer menu
Here is my .readthedocs.yml file which includes commands to build PDF from simple-pdf extension. Although the build succeeds executing all the commands, I cant see the PDF in flyer menu.
# ....
0
votes
0
answers
66
views
Read-the-docs embed in application
new to readthedocs. Digging into trying to see if it's good solution for our organization. We are a B2B SaaS and hardware offering.
I'd like to do 2 things I'm not sure are available:
I want to embed ...
0
votes
1
answer
115
views
ReadTheDocs says: "Failed to checkout revision: master"
I'm trying to set up readthedocs.org integration for a project that is on GitHub. The builds on RTD keep failing with this error: "Failed to checkout revision: master"
This is confusing ...
- 71
0
votes
0
answers
42
views
Inheritance diagram on the XGBoost documentation
How can I view an extended inheritance diagram with more than two layers in the XGBoost documentation, specifically on the TreeUpdater page? Currently, the diagram displayed shows only two layers of ...
- 46
0
votes
1
answer
182
views
How to properly include PyAudio as a dependency for a new Python package, so that the documentation compiles on ReadTheDocs?
I am currently developing a toolbox as a Python package. I have written the documentation using sphinx, and I am in the process of uploading the documentation to ReadTheDocs.
My package has a bunch of ...
- 296
1
vote
1
answer
482
views
How to make ReadTheDocs build graphs using graphviz
I have configured automated documentation building on https://readthedocs.org/ portal.
I am using sphinx.ext.autodoc extension which builds graphs using graphviz.
I am not sure how to configure ....
- 730
0
votes
1
answer
445
views
How to install binary Debian packages from github assets into the ReadTheDocs build environment?
I have a python library that relies on a C library back-end that I'm trying to get into ReadTheDocs. There are Debian packages for the C library available in another git project.
I wrote the ...
- 11
2
votes
1
answer
354
views
how can I make readthedocs find my configuration file which is already in GitHub project repository root directory?
I am trying to publish a Python package's documentation on readthedocs.org.
It was being published in previous releases. However, I am getting
"The configuration file required to build ...
- 107
1
vote
1
answer
436
views
ReadTheDocs has started insisting on alabaster. I want the default theme back
There's lots and lots of advice on how to use a custom theme. I have the opposite problem: Up until recently, all my hosted doc sites used the gorgeous read-the-docs theme by default because that's ...
- 4,718
1
vote
1
answer
279
views
Why is Sphinx READ THE DOCS not updating from our GitHub?
We have Sphinx READ THE DOCS for our TorahBibleCodes GitHub project presented at the following link:
https://torahbiblecodes-sphinx.readthedocs.io/en/latest/usage.html
The source code for display of ...
0
votes
1
answer
810
views
What is modules.rst from sphinx-apidoc?
I am using sphinx==6.2.1 and sphinx_rtd_theme==1.3.0. I ran sphinx-apidoc, and it generated a modules.rst that looks like this:
package
======
.. toctree::
:maxdepth: 4
package
When I go to ...
- 3,071