Stack Overflow
Stack Overflow

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
5
votes
1 answer

Selectively disable readthedocs syntax highlighting

I have an RST file for which I do not want any syntax highlighting. It contains multiple literal blocks and a highlight directive at the top of the file to try to disable syntax highlights: .. highlight:: none :: Text that happens to contain…
Steve
  • 1,250
  • 11
  • 25
5
votes
1 answer

Autogenerated index file in readthedocs

I'm failing to upload to readthedocs the documentation I prepared for my project and I'm trying to understand what's wrong. The documentation builds fine locally with make html but I cannot upload it. The GitHub project is ASCIIGenome and the…
dariober
  • 8,240
  • 3
  • 30
  • 47
5
votes
2 answers

Disable click behavior for images

I am creating html documentation using sphinx and the read-the-docs theme. When I add a scaled image, it can be clicked and pops-up full-size in a new tab. How can I disable this behavior. For example, I am using the following scenario throughout my…
FlGal
  • 51
  • 3
5
votes
1 answer

How to add bitbucket docs to readthedocs

I have a private bitbucket repo which contains: /docs /docs/source /docs/Makefile /docs/make.bat/ /docs/source/conf.py /docs/source/index.rst I want to add this documentation to readthedocs( i have set up the hook in bitbucket) but when it tries to…
HellOfACode
  • 1,675
  • 3
  • 18
  • 38
5
votes
1 answer

python readthedocs how to satisfy the requirement sip (or pyqt)

I want to publish the documentation of my project https://bitbucket.org/oaltun/opn in readthedocs.org. The build fails. There are different errors shown in the log https://readthedocs.org/builds/opn/2247789/ , but the first is "no module named…
O. Altun
  • 685
  • 7
  • 20
5
votes
2 answers

How can i use matplotlib's plot-directive with python-3 in ReadTheDocs?

I'm having a python-3 project that uses the plot-directive to generate and embed matplotlib's diagrams on the fly, and i'm using ReadTheDocs for auto-generating the project's documentation. The plot-directive indeed works ok in python-2, but it…
ankostis
  • 8,579
  • 3
  • 47
  • 61
5
votes
1 answer

What is an easy way to do a local Sphinx build with the static assets readthedocs.org uses?

Currently, the only way I can find to get current design assets used by readthedocs.org is to install the full theme, and build it, which requires SASS, etc. I'd like to just get a static set of files that would let me see locally what my build will…
Dav Clark
  • 1,430
  • 1
  • 13
  • 26
4
votes
1 answer

sphinx-rtd-theme not formatting correctly - missing theme.css

Background: I upgraded my repo to use python 3.9 (was 3.6). Upgraded all the packages to latest. Noticed my docs are not formatting with the sphinx-rtd-theme. See https://docs.members.loutilities.com/en/1.4.1.dev1/ as compared to…
Lou K
  • 1,128
  • 2
  • 12
  • 31
4
votes
0 answers

Sphinx and Read the Docs not using NumPy docs style

I documented some modules of a Python package I wrote using NumPy style, and I set up a readthedocs website to host the automatically generated documentation (with sphinx.ext.napoleon). Despite trying to follow the NumPy documentation style…
Francho Nerín Fonz
  • 311
  • 2
  • 7
4
votes
1 answer

Python code blocks not rendering with readthedocs and sphinx

I'm building docs for a python project using Sphinx and readthedocs. For some reason, the code blocks aren't rendering after building the docs, and inline code (marked with backticks) appears italic. I've checked the raw build, there was a warning…
Sophie Frankel
  • 53
  • 4
4
votes
0 answers

How are cookie queries handled on Read the Docs?

How are cookie queries handled on Read the Docs? Currently, Google Analytics can be used for Read the Docs documentation. However, a cookie is set for this. In order for this to be compliant with the DSVGO/GDPR (European Data Protection Act), a…
Brockoli472
  • 41
  • 1
4
votes
1 answer

Sphinx extensions on readthedocs

Recently I started using the sphinx_autodoc_typehints and the sphinx_autodoc_defaultargs extensions for Sphinx via my project's conf.py. As it seems are not default packages in the sphinx installation on readthedocs (over there sphinx is on v1.8.5).…
MERose
  • 4,048
  • 7
  • 53
  • 79
4
votes
1 answer

Search results in Sphinx do not show text snippets with the searched word

I have installed a Sphinx system using the Read the Doc theme from scratch, with no additional configuration. Search box works well but the search results just show the pages that contain the word that I am searching for, but they don't show a…
Daron Burleson
  • 41
  • 2
4
votes
1 answer

Sphinx RTD theme: Change color of inline code

I use Sphinx with the Read the Docs theme. For small inline code snippets, such as the mention of a single variable among a piece of text, I use double backticks to format the code as what's called "inline literals" in the documentation. Is this…
jmd_dk
  • 12,125
  • 9
  • 63
  • 94
4
votes
0 answers

Build error index.rst not found in ReadtheDocs

I get this when I try to update my docs: sphinx.errors.SphinxError: master file /home/docs/checkouts/readthedocs.org/user_builds/redditeasy/checkouts/latest/index.rst not found It didn't used to show up like that. I looked at Build Fail Sphinx…
Emir Sürmen
  • 884
  • 3
  • 14
  • 33
1 2 3
…
36 37