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

How can I avoid the horizontal scrollbar in a ReST table?

I have this table in ReST markup: +---------------------------+-----------------------------------------------------------------+ | Option Line Kind | Distinguishing Characteristic …
Paebbels
  • 15,573
  • 13
  • 70
  • 139
2
votes
2 answers

How do I configure Read the Docs to use sphinx-autodoc-annotation?

I'm using sphinx-autodoc-annotation to read the function annotations in my Python code and use that to generate the appropriate expected argument types and return types. It's working great on my local machine, but I had to pip install…
Chuck
  • 4,662
  • 2
  • 33
  • 55
2
votes
0 answers

Read The Docs Connect to Bitbucket

I have a problem. I've instaled Read The Docs by manual but when I try to connect to bitbucket I get an error: DoesNotExist at /accounts/bitbucket_oauth2/login/ enter code hereSocialApp matching query does not exist. Request Method: GET Request URL:…
edo
  • 21
  • 3
2
votes
0 answers

Readthedocs: how to ignore requirements file?

I have a project (recently joined) that depends on basemap when running certain tests. Specifying "basemap" in the setup.py alone results in the following on Travis CI: Collecting basemap (from mypkg==1.1.6) Could not find any downloads that…
djhoese
  • 3,567
  • 1
  • 27
  • 45
2
votes
1 answer

ReadTheDocs generates PDFs without my HTML tables

We are converting a sizeable document for hosting on ReadTheDocs. We weren't happy with the simple presentation enabled by Markdown table syntax, so we coded our tables as HTML. Very nice in the HTML viewer (e.g., the end of…
Barry Demchak
  • 101
  • 4
2
votes
0 answers

sphinx-doc documentation on readthedocs.org depends on private sphinxcontrib-package

I host a sphinx-doc website on readthedocs.org which depends on a private sphinx-doc extension/sphinxcontrib-package [extension_name]. On my local pc this extension is located in the subdirectory [sphinx-doc project…
thinwybk
  • 4,193
  • 2
  • 40
  • 76
2
votes
1 answer

How come readthedocs isn't showing latest version?

In the following project: https://readthedocs.org/projects/django-guardian/versions/ Version 1.4.1 isn't showing up. Yet version 1.4.1 is tagged in github, and I have made pushes after this…
Penguin Brian
  • 1,991
  • 14
  • 25
2
votes
2 answers

ReadTheDocs badge red on Github, but should be green

Edit The badge appears green on GitHub now as well. Could it be related to caching done by GitHub? Edit 2 Oh, it's red again. The badge in the ReadTheDocs project here is green. But when I paste the badge HTML or Markdown code into my GitHub…
Niklas R
  • 16,299
  • 28
  • 108
  • 203
2
votes
2 answers

Download HTML as separate pages

I'm using Read The Docs for a project. Everything seems to be working well online. However, when I download the HTML for offline use, I find that the documentation is all crammed into a single HTML file (index.html). Is it possible to download the…
Neal Kruis
  • 2,055
  • 3
  • 26
  • 49
2
votes
1 answer

Read The Docs build failing without errors?

I recently started using Read The Docs and everything has gone very smoothly. Today I tried building a development branch of my project on Read The Docs. The build failed. After a few hours of debugging I switched back to the unchanged master branch…
user3835277
2
votes
1 answer

Sphinx automodule works offline but not through readthedocs.org

I cant seem to get ReadTheDocs to show a any module's :members:, for instance in my local html i get: MODULE module.Beta(r, theta, beta) evaluates Beta at point but after pushing to github the readthedocs doc only says: MODULE No error appears…
ccfima
  • 23
  • 5
1
vote
1 answer

API Reference building locally but not on RTD

I am trying to build an API reference for the Python Package GemGIS using autosummary (see here). The API Reference is built locally without any issues but I am getting ImportErrors and ModuleNotFoundErrors saying that various GemGIS modules are…
Alexander Jüstel
  • 11
  • 1
1
vote
1 answer

Read the docs build module not found error, but no local issue

I am trying to use the sphinx-click module in my rst file for my documentation on Read the Docs. It normally auto-builds from the git repo without any issues but now that I want to use sphinx-click I run into issues: Running Sphinx v5.3.0 Traceback…
justinian482
  • 845
  • 2
  • 10
  • 18
1
vote
1 answer

Is Python 3.7 the latest available version for readthedocs.io?

I am using type hints and when I build my docs in readthedocs.io, it tells me "type is not subscriptable". The error refers to list[str]. def build_pirate_ship(source_path: str=None) -> list[str]: This prevents autodoc from working. But, if I take…
FancyPantsFlower
  • 31
  • 4
1
vote
1 answer

Sphinx, ReadTheDocs and package version

I maintain a package whose documentation I auto-generate with Sphinx on readthedocs.org. For Sphinx/readthedocs I use a conf.py and a properly defined .readthedocs.yaml. Inside the conf.py I use the version: import pybliometrics version =…
MERose
  • 4,048
  • 7
  • 53
  • 79
1 2 3
…
36 37