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
4
votes
4 answers

Fix some very minor issues and rebuild sphinx but got the error "wrong color format"

I had some minimal updates in the "source" folder and rebuilt the HTML using make html command. Everything works fine and I synced the folder to GitHub. However, when I was rebuilding the doc on the Read the Docs website, I got an error like this…
Neo
  • 482
  • 5
  • 17
4
votes
1 answer

Bullet list style for single parameter functions in RTD theme using autodoc and Sphinx?

I've noticed that when I use autodoc with the ReadTheDoc theme, if I have multiple arguments in my functions they are listed in a bullet list style: arg1 arg2 ... but if there is only 1 argument then it is not using the bullet list style which is…
Goffer
  • 97
  • 1
  • 8
4
votes
3 answers

How to self-host Read the Docs using GitHub Pages

How can I setup a CI/CD workflow with gitlab (or GitHub Actions) that generates my own Read the Docs site and is hosted for free using gitlab pages? Is there a fork-ready example repo on gitlab or github that I can use to self-generate and self-host…
Michael Altfield
  • 2,083
  • 23
  • 39
4
votes
0 answers

Sphinx build breaks on Read the Docs with "module not found" Error but builds fine locally

I am trying to build my documentation on Read the Docs but I am getting a dreaded "Module not found" error. If I issue make docs locally in my project's root, everything builds fine so the "Module not found" error is very strange to me. I am using…
zstreet
  • 126
  • 9
4
votes
0 answers

extras_require with readthedocs and poetry

I use poetry to build my package with cython extensions, so install package flag is enabled. I'd like to host documentation via readthedocs. Poetry uses build.py file to generate setup.py with poetry build command. However readthedocs does not…
Ivan Mishalkin
  • 1,049
  • 9
  • 25
4
votes
2 answers

How can I force sphinx to end a chapter when making a pdf?

I'm using sphinx, hosted on https://readthedocs.org , to generate documentation in both HTML and PDF formats. The HTML works fine. The PDF also builds successfully, but has a problem with nesting: I would like each of the top-level .rst documents,…
jez
  • 14,867
  • 5
  • 37
  • 64
4
votes
1 answer

OSError: libusb-1.0.so: cannot open shared object file: No such file or directory while building docs in readthedocs

I am trying to build documentation in readthedocs for a python module. In my python module, I import libusb using command import libusb. libusb package requires a libusb-1.0-0 Debian package which is usually installed via sudo apt install…
Astra Uvarova - Saturn's star
  • 677
  • 2
  • 9
  • 25
4
votes
1 answer

Multiple versions in self hosted Sphinx documentation

I am trying to build documentation for a self hosted GitLab project. This documentation will be hosted in GitLab pages, and will have different versions. Thanks to this answer, I figured out how to host multiple versions on GitLab pages. My problem…
Pablo
  • 377
  • 1
  • 14
4
votes
1 answer

How do I correctly start using .readthedocs.yml

I have a basic ReadTheDocs repository. As per the advice of the build page, I sought to use a .readthedocs.yml to configure it: Configure your documentation builds! Adding a .readthedocs.yml file to your project is the recommended way to configure…
Kristian Glass
  • 37,325
  • 7
  • 45
  • 73
4
votes
1 answer

How to create a horizontal line and white space between function signatures in Sphinx autodoc

I have found sphinx options for most of what I want to do, but I can't see how to inject white space and a horizontal line between function signatures when using autodoc. Here's what autodoc produces: get_all_edges(network=None,…
bdemchak
  • 263
  • 2
  • 10
4
votes
1 answer

Sphinx fails to import module dependencies

The python tool that writing, awscli-bastion, has the following directory structure built by cookiecutter. . ├── awscli_bastion │ ├── __init__.py │ ├── cache.py │ ├── cli.py │ ├── credentials.py │ ├── minimal.py │ └── sts.py ├── docs │ …
aidanmelen
  • 6,194
  • 1
  • 23
  • 24
4
votes
1 answer

How to redefine MagicMock __str__ method?

I'm trying to autogenerate documentation for Readthedocs. I mock some dependencies as they suggest in FAQ, but from type annotations of functions I get some parts of documentation to look like Return type: Which…
Bunyk
  • 7,635
  • 8
  • 47
  • 79
4
votes
0 answers

Sphinx: Use already translated files without creating translatable files

I am trying to figure a way to use already translated .md files (Russian Language) with Sphinx. I use readthedocs.io and I have already read the process of making translatable files (.po/.pot) from: (1)…
Pant
  • 51
  • 4
4
votes
1 answer

Read the docs search broken

I am trying to write up a documentation using Sphinx in combination with the read the docs theme, but the search function seems to be broken. I am running Python 3.7 with the latest version of Sphinx and the Read the Docs Theme (both installed with…
New2Coding
  • 181
  • 13
4
votes
2 answers

How to keep TOC visible on side when scrolling down?

I am attempting to use the built-in theme 'sphinxdoc' for my reStructuredText documentation that's being built with Sphinx for deployment on readthedocs.io. This works as I was hoping except for the behavior of the table of contents, which stays at…
James Adams
  • 8,448
  • 21
  • 89
  • 148
1 2 3
…
36 37