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

RTD compiles all my docs including foreign docs from git submodules

I'm experimenting with Sphinx and ReadTheDocs (RTD) to compile my documentation on every GitHub push. Unfortunately, RTD found multiple doc/docs folders containing a conf.py file. My repository uses git sub-modules to embed third party libraries.…
Paebbels
  • 15,573
  • 13
  • 70
  • 139
0
votes
0 answers

Cannot create readthedocs from enterprise git repository

I am trying to create a RTD page from a GitHub Enterprise repository. It is public and you can view it here. However, I am getting an error while importing my repository in RTD: This repository doesn't have a valid webhook set up. That means it…
Komal Rathi
  • 4,164
  • 13
  • 60
  • 98
0
votes
1 answer

readthedocs, local instance, building documentation never concludes

I started with fresh install of readthedocs.org: http://read-the-docs.readthedocs.org/en/latest/install.html Next I have added SocialApp GitHub in admin panel and then connected my superuser to that GitHub account. Then I went to github and I forked…
Drachenfels
  • 3,037
  • 2
  • 32
  • 47
0
votes
1 answer

Issue when building documentation on read the docs

I'm currently trying to build documentation for my Sphinx restructured text project on readthedocs.com. The documentation itself is in its own github repository. I have already added the webhook for rtd in the repo on github, but for some reason,…
loremIpsum1771
  • 2,497
  • 5
  • 40
  • 87
0
votes
1 answer

Place minor pages in the right place in the TOC

In my sphinx documentation, I have some minor pages that (of course) need to be part of the toctree, but I can't get them listed in the right place. If my "section 3" page looks like so: .. toctree:: 3.3 …
bukzor
  • 37,539
  • 11
  • 77
  • 111
0
votes
1 answer

sphinx - several files in a chapter and clean html-navigation with rtd-theme possible?

I'm using sphinx 1.3.4¹ to write my documentation, make html uses the „read the docs“ theme². When I include a file chaper1.rst in index.rst with headings from Lv 1 to Lv3 in this document, I see heading lv 1 in my resulting navigation-sidebar.…
ThorstenS
  • 317
  • 1
  • 7
0
votes
2 answers

Disabling the top navigation bar (breadcrumbs) in Sphinx ReadTheDocs theme

I would like to disable the top navigation bar of the ReadTheDocs theme. For other theme, for instance classic it is just an option html_theme = "classic" html_theme_options = { "showrelbartop": False } How I can modify the read the docs theme…
Martin Rosalie
  • 117
  • 9
0
votes
1 answer

read the docs build failed UnicodeDecodeError

I am on https://readthedocs.org, I try to build my projet doc written in python3. settings: documentation type : Sphinx html programming language : python use a virtualenv python interpreter : CPython 3.x it failed at: python…
Thykof
  • 895
  • 7
  • 9
0
votes
1 answer

Disable/modify readthedocs shorturl

I've built a containerized readthedocs installation. Happy with it so far, however I see that it builds short urls on the project page. Unfortunately the short url's don't exist in DNS, so don't link anywhere. For example, they appear as…
Paul Dundee
  • 1
  • 1
0
votes
2 answers

Is there a private version of readthedocs?

I am developing an in house application which is proprietary, and I want to build and host the documentation somewhere. Due to the nature of it being proprietary, I cannot use the public version of readthedocs. Is there a paid or private version of…
Muhammad Lukman Low
  • 8,177
  • 11
  • 44
  • 54
0
votes
2 answers

Doing a sphinx extension that folds sections in the body

I try to do an extension in Sphinx, the idea would be that the extension detects the title of sections and then transform them into a fold section, ie that sphinx render a title with a prefix button that helps to display or not the content of the…
Erwan Ledoux
  • 11
  • 1
0
votes
1 answer

Readthedocs mock not working with Matplolitb

Read the Docs will not build docs for my package because it includes matplotlib. I used the code on their website to mock out matplotlib, but still the build fails because freetype and png are required to build matplotlib, and apparently this is not…
Cokes
  • 3,743
  • 6
  • 30
  • 41
0
votes
1 answer

readthedocs self-hosting AttributeError: 'Settings' object has no attribute 'REDIS'

Attempting to self-host readthedocs internally and had very little experience with Django. I've followed all the steps on readthedocs (created virtualenv in /usr/share/ owned by me with group ownership www-data) for the development webserver and…
Alasdair
  • 566
  • 1
  • 4
  • 16
0
votes
0 answers

How to import a project from repository for readthedocs?

I have a project on a github repository, and I'm trying to build a documentation for it, based on its markdown files. I decided to use readthedocs for it, however, I'm having trouble importing it correctly. While trying to build the docs, it returns…
Michał Szydłowski
  • 3,261
  • 5
  • 33
  • 55
0
votes
1 answer

Error: The xxx module cannot be found

I'm tring to build this doc (conf.py in doc/source/conf.py) on readthedocs.org. Build fail (full trace here): html ----- Error: The 'pytz.lazy' module cannot be found. Did you install Sphinx and its dependencies correctly? I try to WIPE the build…
bux
  • 7,087
  • 11
  • 45
  • 86
1 2 3
…
36
37