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

Sphinx Read the Docs - Use icon-only in texts

I want to use some informative icons that depict specific meanings. Hover your mouse over an icon and you see a tooltip showing what it means. Allow non-graphical user agents (e.g. browsers that do not support CSS, text-to-speech devices) to read…
Culip
  • 559
  • 8
  • 24
0
votes
0 answers

Enable highlighting for autodocs-linked viewcode sections

I recently changed my html theme in sphinx from alabaster to sphinx_rtd_theme, and there is one feature that I'm missing. When opening a code section with the viewcode extension, the linked code block will be highlighted (the yellowish background…
Arne
  • 17,706
  • 5
  • 83
  • 99
0
votes
1 answer

How to prevent automatic toctree entry numbering?

I am building my documentation with Sphinx, to use with readthedocs.io. So far this always worked well. I'm orienting myself at the (in my opinion) excellent documentation of the godot engine. Since I appreciated the titles in the documentation of…
Baut
  • 59
  • 3
0
votes
1 answer

Version not displayed in readthedocs

Readthedocs does not display the version of my github package. It states latest, while I specified the version to be 0.1.1 in my conf.py file: version = "0.1.1" release = version The thing is that when I compile locally through make html, I see…
Marouen
  • 907
  • 3
  • 13
  • 36
0
votes
1 answer

Readthedocs is not serving my documentation

I'm working on serving the doxygen documentation for our C++ project on readthedocs so it gets built automatically and documentation for all versions is available. I'm using doxyrest to convert doxygen XML output to RST and this build fine both on…
neworderofjamie
  • 117
  • 8
0
votes
1 answer

Theme change using conf.py now ignores my .md files for the toctree when importing

I am moving a technical document over from GitHub/gitbook and using Sphinx on RTD, with default import with no sphinx files outside of an index.rst for toctree created and default settings in RTD it works fine, displays well and looks much better…
Blithespirit
  • 3
  • 2
0
votes
1 answer

Menu entry in toctree expands/collapses on click and doesn't change page content?

As per the title, is it possible to have a menu entry where the entire entry acts like the +/- for expanding and collapsing and doesn't change the active page? A bit like when you are already on the actual entry and click it again it only…
mje
  • 3
  • 1
0
votes
1 answer

Sphinx / ReadTheDocs still tries to build a module when I try to mock it

I am attempting to build documentation using Sphinx on ReadTheDocs, for a project that depends on a bunch of pydata packages, some of which depend on C libraries which are not available on ReadTheDocs (namely the python-snappy package, which…
Zane Selvans
  • 11
  • 3
0
votes
1 answer

Using extra CSS file with Mkdocs hosted by ReadTheDocs

I have written some custom CSS I would like to be included in a Mkdocs site hosted by ReadTheDocs. It is not working because RTD isn't serving the CSS file. I have a .readthedocs.yml file that asks RTD to use Mkdocs: version: 2 mkdocs: …
adam smith
  • 764
  • 7
  • 16
0
votes
1 answer

Problem setting up Github webhook for ReadTheDocs

I'm starting to use ReadTheDocs for the first time and trying to connect it to my GitHub repo. When I go into the repo on Github, select Settings then select Webhooks from the menu I thought it was supposed to display a dropdown list of webhooks,…
nakb
  • 321
  • 1
  • 3
  • 16
0
votes
2 answers

Deploying MkDocs documentation on Read the Docs using an organization's private repository

I am leaving my internship currently and I'm in the process of writing documentation for the summer intern that is taking over after I graduate. I have written all of my docs in Markdown using MkDocs and I'm ready to deploy them. My docs use the…
Justin Dunlap
  • 109
  • 1
  • 3
  • 12
0
votes
1 answer

How does readthedocs generate Sphinx HTML from RST without a conf.py?

I am looking at making changes to an existing project hosted on github and readthedocs. However the generated HTML looks to be built by Sphinx without a conf.py. $ ls appendixA.rst chapter11.rst chapter17.rst chapter4.rst html …
Adam Burke
  • 724
  • 1
  • 7
  • 21
0
votes
1 answer

SphinxRtdTheme undefined after making custom-named fork of sphinx_rtd_theme

I am working on a theme which is a fork of sphinx_rtd_theme. I renamed the theme so that people who would use the theme would not have to worry about overwriting their usual sphinx_rtd_theme. However, when building documents using the custom theme,…
KDM
  • 81
  • 7
0
votes
1 answer

How to build the cython doc on readthedoc and in local

I am currently working on a cython project. After following some tutorials, I was able to build in place cython, then use sphinx build with the line sys.path.insert(0, os.path.abspath('../../')) # path to my_package in my conf.py to make it…
BlueSheepToken
  • 5,751
  • 3
  • 17
  • 42
0
votes
0 answers

How to use docson widget with Sphinx on ReadTheDocs

I'm working on the documentation (https://global-coffee-data-standard.readthedocs.io) of my JSON schema (https://raw.githubusercontent.com/andrejellema/GlobalCoffeeDataStandard/master/schema/global-coffee-data-standard.schema.json) The basics I have…
Paul Meems
  • 3,002
  • 4
  • 35
  • 66
1 2 3
…
36 37