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

restructuredtext TOC subgroups

I'm trying to get a TOC with subgroups pointing to different rst files. This is my index.rst: .. bonobo-trans documentation master file, created by sphinx-quickstart on Fri Feb 8 18:09:07 2019. You can adapt this file completely to your…
svenema
  • 1,766
  • 2
  • 23
  • 45
0
votes
0 answers

Sphinx unlimited tocdepth

I am stuck on the depth of the toctree of my sidebar doc. Here's my doc : https://aff3ct.readthedocs.io/en/user_doc_dev/simulation/parameters/cdc/cdc_bch/cdc.html As you can see, on the sidebar the toctree does not go deeper than the fourth level,…
Oliver
  • 69
  • 6
0
votes
1 answer

Image size on Read the Docs (small images width)

I'm using MkDocs to generate docs using Markdown, and the theme Read the Docs. However, I'm having trouble getting small images from scaling up on mobile phones. I think this is linked to the Read the Docs CSS, but I'm having trouble understanding…
NBajanca
  • 3,544
  • 3
  • 26
  • 53
0
votes
1 answer

Permission denied after successful build

I am trying to import my first project into Read the Docs (readthedocs.io). After much fidgeting with the git hooks, I am now able to import and successfully build my mkdocs repo. But as soon as I click on "View Docs", I have the following error on…
Costantino Pipero
  • 95
  • 3
  • 11
0
votes
1 answer

How can I see if the file "readthedocs.yml" is used at all?

How can I check in the build logs if readthedocs.yml has been used? This should install sphinx-argparse but it does not. My project: https://gpxity.readthedocs.io I added readthedocs.yml with extra_requirements: - doc and in…
Wolfgang Rohdewald
  • 46
  • 2
0
votes
1 answer

read-the-docs build fails because of prompt

I am developing a Python package which, on first use, creates a config file for the user. During this setup phase, the user is asked for input during two prompts. Corresponding calls are in the module's __init__.py. Because of this prompt, my…
MERose
  • 4,048
  • 7
  • 53
  • 79
0
votes
0 answers

Readthedoc and sphinx image path

I'm trying to build the doc for a Python package on readthedoc.org using sphinx on rst files. The doc is built as expected except for images that I'm unable to properly reference. What would be the proper way to reference the image produced by…
dputhier
  • 734
  • 1
  • 7
  • 23
0
votes
1 answer

Python MagicMock mocks too much when using decorator

I am trying to get documentation to build on a ReadTheDocs installation via Sphinx. The classes I am documenting inherit from a larger Framework, which I cannot easily install and thus would like to mock. However, Mock seems to be overly greedy in…
Steffen Hauf
  • 1
  • 2
0
votes
1 answer

Image is not displaying on Read the Docs, but it is displayed on Github, what is wrong?

I am trying to add an image to one of the .md files for our read the docs. I am putting this on my .md file:

Once I commit, It looks fine when I look at…
Rafael Suarez Leon
  • 1
0
votes
1 answer

ReadTheDocs downloads wrong package

Basically, the issue I'm having is that my package requires both click and click-default-group. However, during build, when ReadTheDocs tries to install click, it ends up installing click-default-group instead and then raising an error that click…
Benjamin Lee
  • 481
  • 1
  • 5
  • 15
0
votes
0 answers

Add id to body of index.rst in Sphinx documentation?

To customize a certain page in my documentation, I'd like to add a special class or id to the body of the page. I've tried using :name: amazing-unique-id; at the top of my index.rst file, but this doesn't work. Any idea how I could achieve that?
vinni
  • 633
  • 2
  • 8
  • 32
0
votes
1 answer

sphinxcontrib.programoutput works locally, doesn't work on ReadTheDocs

I am trying to use sphinxcontrib.programoutput to automatically document the --help command of my software. My rst looks like this: .. command-output:: squiggle --help And works exactly as expected locally. However, when I go to put it on…
Benjamin Lee
  • 481
  • 1
  • 5
  • 15
0
votes
0 answers

How do I document my main function with Sphinx autodoc?

I have a problem when building my documentation with Sphinx autodoc. My project consists of different modules which contain classes. The documentation for these modules is generated correctly. But there is one module (in my case called…
A. L
  • 131
  • 2
  • 12
0
votes
2 answers

Sphinx autodoc - decorator and ReadTheDocs

I am having a little trouble with Sphinx auto-generated documentation with autodoc. I basically have the same issue as here : Python Sphinx autodoc and decorated members When I used a decorator on a function, the signature shown in the documentation…
Pier-Yves Lessard
  • 582
  • 5
  • 20
0
votes
0 answers

Sphinx build failing on ReadTheDocs

I'm trying to build the documentation for a project using ReadTheDocs. The Sphinx build script is failing with: error: option -T not recognized. I double checked the Sphinx documentation, and the -T option has been available since version 1.2.…
Dylan Klomparens
  • 2,853
  • 7
  • 35
  • 52
1 2 3
…
36 37