Questions tagged [read-the-docs]

Free documentation hosting for the Open Source community

Read The Docs is a free website providing documentation hosting for open source software, using either Sphinx or MkDocs. It can pulls from Subversion, Bazaar, Git and Mercurial repositories.

Links

548 questions
2
votes
1 answer

Read The Docs not updating

Read The Docs seems to be stuck on an old version of my docs and whatever I do in won't update. I even tried deleting the project from Read The Docs completely and reimporting the github repo - it still shows the old version. The builds show as…
chasmani
  • 2,362
  • 2
  • 23
  • 35
2
votes
0 answers

Proper way to reference ReadTheDocs page (with or without .html in path)

I have a github project called amrlib where I link to my ReadTheDocs pages in the main README. For some reason I now seem to need to use links without .html in them. However, at some point in the past the .html was required. I'm now wondering…
bivouac0
  • 2,494
  • 1
  • 13
  • 28
2
votes
1 answer

"Searching..." takes forever on readthedocs when the phrase is not present on the page

When I search for a phrase which is not present on the readthedocs page, I get the message: "Searching...", which will take forever. On the contrary, when I search for some known phrase, I get the results within a second. I have looked into page's…
Maria
  • 176
  • 1
  • 11
2
votes
0 answers

Configure logo for ReadTheDocs site using MkDocs engine

Maybe a missing feature; not sure. How would we go about adding the site/project logo top left in a ReadTheDocs site using the MkDocs engine? At https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html#adding-a-logo (and some SO questions)…
Marcel Stör
  • 22,695
  • 19
  • 92
  • 198
2
votes
2 answers

nbsphinx causes build to fail when building Jupyter Notebooks

Details I am getting a build failure of my read-the-docs that I don't understand. The assertion of "verbatim" in line 2151 of nbsphinx.py is causing the build failure. So the build fails when I try to include the Jupyter Notebook tutorials I…
2
votes
2 answers

Sphinx - How to maintain side bar content between pages?

I have this source directory structure: . ├── conf.py ├── devel │   └── python │   ├── Controles de flujo, condicionales y bucles.md │   ├── Encapsulamiento.md | ├── (...) ├── index.rst ├── _static ├── _templates └── webdevel This is…
2
votes
2 answers

Docstrings are not included in Read the Docs Sphinx build

I built a Sphinx documentation and the build works well locally. My docstrings appear as shown below. When moving to readthedoc.io, I added a specific requirement file under docs/requirement.txt which…
clematologie
  • 177
  • 1
  • 9
2
votes
0 answers

Read the docs autodoc works on Master but not Latest build

I am experiencing some strange build behaviour for my project on Read The Docs. When building the "Master" version the autodoc is generating the documentation properly. However, if I build "Latest" version then the autodoc generated documentation is…
Mike Smith
  • 41
  • 5
2
votes
1 answer

Is it possible to create docs for multiple packages within the same git repository with sphinx-apidoc?

I have a git repository which includes multiple packages which follow a namespace (i.e PEP 420. I am trying to create a ReadTheDocs documentation using Sphinx. The git repository looks like this repo:…
2
votes
1 answer

ReadTheDocs and autodoc fail to find my package during build

I have been trying to build docs on readthedocs for my debut python package QutiePy. Building the docs works fine locally, but when I try to build on readthedocs, autodoc fails to populate my sections and gives the following warning: WARNING:…
2
votes
1 answer

Read the Docs with nbsphinx

I created my own docs for Read the Docs. See my repository Some of my docs files are jupyter notebook so I used nbshpinx for it. In my computer I installed all the dependencies and it works great when I use make html. However, Read the docs throws…
J Agustin Barrachina
  • 3,501
  • 1
  • 32
  • 52
2
votes
1 answer

Build completed, but View Docs links broken

I have installed a local ReadTheDocs server and think I am very close to having it working. However, while the build of my documentation project says that it is complete, and I can see the generated files under the…
Malcolm
  • 461
  • 2
  • 10
2
votes
1 answer

How do I make my sphinx directive add assets to _static folder?

I'm building a custom sphinx extension and Directive to render interactive charts on sphinx and ReadTheDocs. The actual data for a chart resides in a .json file. In a .rst document, including a chart looks like this: .. chart:: charts/test.json …
thclark
  • 4,784
  • 3
  • 39
  • 65
2
votes
1 answer

How to Internationalize Sphinx (i18n)

From the defaults following an execution of sphinx-quickstart, how do I get language-specific directories like what's used by Read The Docs? I'm starting a new Sphinx documentation site that's hosted by GitHub Pages, built with GitHub Actions, and…
2
votes
1 answer

Read the Docs local install: Celery ValueError: signal only works in main thread

I have a local readthedocs install and get a ValueError exception when trying to import a project. I'm on release 5.1.0, running python 3.6 on Debian buster with celery 4.1.1 (from the requirements files). From the debug.log: [19/May/2020 23:31:11]…
luds
  • 331
  • 2
  • 13