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
3
votes
0 answers

Style guide check for Google-style docstrings for Sphinx/readthedocs?

We're building our documentation using Sphinx v3 with Read the Docs using sphinx.ext.napoleon and Google-style docstrings. When we build locally, Sphinx doesn't catch badly-formatted Google docstrings as warnings. For example: """ This should go…
user4793385
  • 145
  • 5
3
votes
1 answer

See all warnings as errors when building Sphinx docs on readthedocs.org

Our open-source Python project (PyAbel) uses readthedocs.org to automatically build the documentation for each pull request using Sphinx. We would like the doc build to fail if there are any warnings from Sphinx, since these usually indicate that…
DanHickstein
  • 6,588
  • 13
  • 54
  • 90
3
votes
1 answer

hyperledger-fabric-readthedocs.io tutorial, chaincode for developers, can't find package shim - FIXED

I worked out the solution to this problem as I was creating this post but figured I'd leave my trail of tears up here to maybe help other people who have run into the same thing. Ultimately the root of the problem was outdated instructions in the…
user55836
  • 31
  • 1
3
votes
0 answers

Grid table cells aligning incorrectly in reStructuredText using Sphinx Read the Docs theme

I created a grid table like the one below in reStructuredText and I'm using Sphinx and the ReadtheDocs theme to generate documentation. However when I render in HTML, the cells in Columns A and B vertically align in the center (because of the row…
Audrey Tavares
  • 31
  • 3
3
votes
0 answers

Documenting a Python C Extension on ReadTheDocs

I have a Python package including a couple C extensions whose documentation I would like to host on ReadTheDocs, but the build fails, apparently because the C extensions are not being compiled. The C extension modules include functions with…
Geoff Ryan
  • 353
  • 1
  • 2
  • 7
3
votes
1 answer

I'm having problems with the project building on Read the Docs

Created sphinx project with sphinx-quickstart. Ran "make html" and no errors produced. Pushed all the code to GitHub. I tried to import and build project on Read the Docs, but get the following errors. I haven't problems when using a Mac- it…
Kevin
  • 667
  • 2
  • 7
  • 18
3
votes
1 answer

read-the-docs with github webhook results in 400: "Payload not valid, invalid or missing signature"

I have followed the instructions on https://docs.readthedocs.io/en/stable/webhooks.html and added a webhook to github to trigger my readthedocs built, however readthedocs rejects the payload: Response Status: 400 Content-Type: text/html;…
kuropan
  • 774
  • 7
  • 18
3
votes
0 answers

"Private" permission setting in readthedocs.org - how does it work?

I'm aware RTD has a commercial version which offers Private settings. With that in mind, why is there a "Private" version option in the community? Public can be seen by anyone, including search bots Protected only shows through direct link Private…
lucasgcb
  • 1,028
  • 7
  • 15
3
votes
0 answers

Using autosummary_generate = True with readthedocs

I have been trying to publish some documentation and can't get it to work. From what I can tell it looks to me as if readthedocs is ignoring the autosummary_generate = True directive in conf.py I am using autosummary and it works well on my local…
Kjetil
  • 31
  • 3
3
votes
1 answer

Invalid "requirements_file": path docs/requirements.txt does not exist

While updating the docs on my project using ReadTheDocs, I have no suddenly started getting this error: Problem parsing YAML configuration. Invalid "requirements_file": path docs/requirements.txt does not exist What's strange is that there very…
Benjamin Lee
  • 481
  • 1
  • 5
  • 15
3
votes
1 answer

Requiring PsychoPy fails readthedocs build due to memory consumption

I have a project (https://github.com/jfkominsky/PyHab) which is essentially an extension of PsychoPy (http://psychopy.org/). I want to use Sphinx and ReadTheDocs for code documentation. I use the autoclass features from Sphinx for my documentation…
jfkominsky
  • 41
  • 4
3
votes
1 answer

How to correctly setup for PyQt5 imports on readthedocs?

Building the sphinx documentation of a project importing PyQt5 fails (build log) with QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-docs' qt.qpa.screen: QXcbConnection: Could not connect to display Could not connect to any X…
ederag
  • 2,409
  • 25
  • 49
3
votes
2 answers

Running out of memory on ReadTheDocs

I have a project on ReadTheDocs. As part of the documentation generation, I have Sphinx compile a large number of images using matplotlib's plot directive showing what various commands do. It seems this takes more memory than RTD allocates for a…
Richard
  • 56,349
  • 34
  • 180
  • 251
3
votes
1 answer

How to preserve part/chapter structure in Sphinx without creating a single, long, page?

I've learnt that it's possible to maintain my documentation in a modular form with parts/chapters etc. across multiple files by using the include command. The only problem with this approach is that it effectively concatenates all included files…
AZD
  • 279
  • 1
  • 8
3
votes
1 answer

Sphinx Documentation Language, Version and Downloads links

I'm searching for syntax / extension to include Language, Version and Formats links via shortcut similar to the one at the bottom-right of Sphinx documentation page: Is it an reStructuredText directive or Sphinx extension that generates these links…
Ajay
  • 344
  • 3
  • 15
1 2 3
…
36 37