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

Read the Docs theme - change the "Edit on github" link using Sphinx

I am using read the docs theme to create a HTML content using sphinx. In the theme, I want to edit the hyperlink for "Edit on Github" section. I am able to enable or disable the link using the following variables in the conf.py file. html_context =…
tribe
  • 61
  • 2
6
votes
3 answers

How can I use automodule or autoclass for Sphinx in a markdown file?

I understand the Sphinx supports markdown or .md files optionally, which works great for me for my supplimental documentation. What I am trying to do is use the autoclass or automodule tags in a markdown file. Normally, in a .rst file, if I do ..…
securisec
  • 3,435
  • 6
  • 36
  • 63
6
votes
2 answers

ReadtheDocs config for setup.py installation

I'm trying to automatically import a project from Github into ReadtheDocs. When creating the documentation it is failing due to a missing dependency. I've tried adding the setup.py installation in the config, but am running into the…
jdk514
  • 106
  • 5
6
votes
1 answer

Readthedocs does not display docstring documentation

I have followed the getting started guide on Readthedocs and have used Sphinx using autodoc to create the documentation for my Python package on https://github.com/akdiem/bloodflow. (documentation relevant .rst files are in the docs folder) The…
glanne
  • 71
  • 5
6
votes
2 answers

Enable versions in sidebar in sphinx read the docs theme

I would like to include the versions.html in the sidebar and could not succeed. I tried to add versions.html in ** for sidebars, this had no effect: html_sidebars = { '**': ['versions.html'] } Also how to declare the different versions in…
Denis Rouzaud
  • 2,412
  • 2
  • 26
  • 45
6
votes
1 answer

Is there a way to delete a project on readthedocs.org?

I'm getting started with readthedocs.{org,io} and created a project in error that I'd now like to delete. I've looked at the various things I can do to a project and am not seeing any buttons labeled "Delete" and I'm not finding any documentation…
Tom Barron
  • 1,554
  • 18
  • 23
6
votes
1 answer

How to center website content (body and navigation bar) in rtd sphinx?

I am creating documentation using the Read the Docs theme for Sphinx documentation. I am trying to center the entire webpage - both the body and the left navigation bar, such that if the width of the window increases, the margin on both the left and…
Adam Turner
  • 61
  • 1
6
votes
2 answers

ReadTheDocs not parsing docstrings in Python modules (Sphinx)

I have open-sourced some of my code, but the documentation won't build properly on ReadTheDocs despite working as expected with the Makefile created by sphinx-quickstart and make html locally. Can anyone please advise as to what I'm doing wrong with…
Arran Schlosberg
  • 380
  • 2
  • 11
5
votes
1 answer

How to fix error "Duplicated build" on "readthedocs"?

On readthecods I am trying to build a project, but I get the error Error Duplicated build. How to fix that problem?
Alex
  • 41,580
  • 88
  • 260
  • 469
5
votes
1 answer

How do I replace "View page source" with "Edit on GitHub" links in sphinx_rtd_theme?

How can I replace the View page source hyperlink at the top of my docs pages with a Edit on GitHub link when building a Sphinx site using the sphinx_rtd_theme theme? I'm manually building a readthedocs.io-like site using GitHub Pages, but the link…
Michael Altfield
  • 2,083
  • 23
  • 39
5
votes
1 answer

Sphinx: how to change html title?

I'm working on my RTFM Documentation and I d'like to change the html-title. Currently, my title looks like this: [PAGE TITLE] — My Documentation documentation Everything the [PAGE TITLE] part as well as - My Documentation part is…
roland
  • 101
  • 2
  • 7
5
votes
1 answer

ReadTheDocs + Sphinx + setuptools_scm: how to?

I have a project where I manage the version through git tags. Then, I use setuptools_scm to get this information in my setup.py and also generates a file (_version.py) that gets included when generating the wheel for pip. This file is not tracked by…
norok2
  • 25,683
  • 4
  • 73
  • 99
5
votes
0 answers

Combining conda install with running setup.py in read-the-docs

I am trying to add read the docs to view our github hosted project's documentation. The project is Calour - an interactive heatmap analysis program for microbiome experiments. We have a large set of requirements for the project - some are conda…
barvazim
  • 51
  • 2
5
votes
1 answer

Rendering discrepancy between ReadTheDocs and localhost

I have just uploaded my documentation from Github to ReadTheDocs and I have found that it renders completely different on ReadTheDocs and my local machine. I am using the latest sphinx_rtd_theme on my local machine. Here is the display on my local…
Jonathan
  • 2,635
  • 3
  • 30
  • 49
5
votes
3 answers

Sphinx autodoc on readthedocs: ImportError: No module named _tkinter

I'm trying to build documentation on https://readthedocs.org/. I cannot see the docstrings for any files that import matplotlib. When I look into the build log, I see that from matplotlib import pyplot as plt failed, with the…
Peter
  • 12,274
  • 9
  • 71
  • 86
1 2 3
…
36 37