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

Add a warning directive at the top of every page on a Sphinx RTD site

I'd like to add a simple warning directive at the top of every page on a Sphinx RTD site: .. attention:: The next major release of this project will launch on X date. In the meantime, we're looking for feedback. If you'd like an early…
Abe
  • 22,738
  • 26
  • 82
  • 111
2
votes
1 answer

Google Cloud Platform: Integrating Cloud Source Repository and ReadTheDocs

My project initially used Github and a private repository to host the code base for the company i've been working for. In order to separate my account from the code I developed for that company, I recently stumbled upon Google Cloud Platforms' Cloud…
delarond2004
  • 41
  • 5
2
votes
0 answers

How to skip Python source files in readthedocs Sphinx build

How can I tell readthedocs not to load any Python files located at top root folder? Background: I would like readthedocs to build Sphinx documentation for a Blender Python add-on, hosted on github. I have created docs folder in the repository for…
Tuomo Keskitalo
  • 21
  • 2
2
votes
1 answer

nbsphinx syntax highlighting on readthedocs

I have a readthedocs sphinx documentation which uses nbsphinx to display jupyter notebooks. When I build the documentation locally with autobuild, I have syntax highlighting in the code cells in the jupyter notebook. But on readthedocs, the code…
Randrian
  • 1,055
  • 12
  • 25
2
votes
1 answer

How to add inheritance diagram to all modules in Sphinx?

So I've been trying to get Sphinx to generate inheritance diagrams for all submodules / classes when generating .rst files through sphinx-apidoc, similar to this example. But I have not found any built-in features to do this in Sphinx. The nearest…
joneivinds
  • 61
  • 5
2
votes
1 answer

How to add favicon for mkdocs websites?

I am developing mkdocs website. Here I need to add favicon for my website. I tried like this but it is not working. I added site_favicon in mkdocs.yaml file and using readthedocs theme. But it is not working site_favicon: img/favicon.ico Can anyone…
Rajitha Kothapally
  • 253
  • 1
  • 3
  • 11
2
votes
1 answer

Code block in a numbered list messes up numbering python-markdown/mkdocs

I am creating a list of instructions for one of my projects in mkdocs, which I believe uses python-markdown as its markdown engine. But when I try to put a fenced code block in between numbers in the list it renders the numbering wrong. An example…
yo76yo
  • 138
  • 7
2
votes
1 answer

Code Formatting for the ReadTheDocs System

I'm using Read the Docs for the first time. I'm writing docs for a command line system, and my "code samples" include a log of shell output. The shell output ends up looking like this That is -- the service (or my use of it?) is trying to format…
Alana Storm
  • 164,128
  • 91
  • 395
  • 599
2
votes
1 answer

sphinx autodoc creates blank page on readthedocs, but correctly includes module docstring locally

I'm getting different results from autodoc when I run sphinx locally (versions 1.6.6 or 2.0.1 on Anaconda Python 3.6.8 for Mac) than when I run it on readthedocs.org (according to their log it's Sphinx version 1.8.5, and probably Python 2.7 since…
jez
  • 14,867
  • 5
  • 37
  • 64
2
votes
0 answers

How do you configure the nav pane to show the PDF and epub options?

I've created a project (https://writing-fundamentals-guide.readthedocs.io/en/latest/) on ReadTheDocs that uses mkdocs to generate the output from markdown files in Github using the Readthedocs theme. The problem is that the little version drop-down…
Jackie Wheeler
  • 46
  • 2
2
votes
0 answers

How to add numpy to required dependencies in autodoc

I get an error when trying to generate the documentation in readthedocs.org, autodoc is failing to import a set of functions with the following error message: WARNING: autodoc: failed to import function 'open_template' from module 'pypyt'; the…
llulai
  • 627
  • 1
  • 6
  • 9
2
votes
0 answers

How to document a JSON Schema

I'm working on a Json Schema: https://github.com/andrejellema/GlobalCoffeeDataStandard/blob/master/global-coffee-data-standard.schema.json I need to document this and am looking at ReadTheDocs. With it, I can manually create .rst-files, but I want…
Paul Meems
  • 3,002
  • 4
  • 35
  • 66
2
votes
2 answers

How to add "Fork me on Github" ribbon using Sphinx and ReadTheDocs theme?

Many open-source projects use a "Fork me on Github" banner at the top-right corner of the pages in the documentation. To name just one, let's take the example of Python requests: There is a post on the Github blog about those banners where image…
Delgan
  • 18,571
  • 11
  • 90
  • 141
2
votes
1 answer

Readthedocs not including theme css

I am compiling Readthedocs locally using below conf.py and it works fine: # -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list…
HP.
  • 19,226
  • 53
  • 154
  • 253
2
votes
1 answer

Remove /en/latest from URLs by default in readthedocs.org

I love the readthedocs.org service. However, for some projects I don't care deeply about having different stable and latest versions, and I expect to only have documentation in English for the forseeable future (sorry). I'm fine with having my…
MRocklin
  • 55,641
  • 23
  • 163
  • 235
1 2 3
…
36 37