read-the-docs

问题 I have this table in ReST markup: +---------------------------+-----------------------------------------------------------------+ | Option Line Kind | Distinguishing Characteristic | +===========================+=================================================================+ | **Reference** | The option name is called a (node) reference, if the value\ | | | of an option is a predefined keyword for the current node\ | | | class. Because the option's value is a keyword, it can not\ | | | be

问题 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 3.4 3 ===== 3.1 ----- 3.2 --- Then 3.3 and 3.4 are listed before 3 . I've tried other permutations, but none seem to work. If I put the toctree after the 3 heading then 3.3 and 3.4 are listed between 3 and 3.1 . If I put the toctree at the end of the page, everything is in the right order,

问题 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 and when I build it to html locally it runs without warnings. Any hints would be greatly appreciated! 回答1: Check your Build logs in readthedocs.org dashboard. Most likely you are using third party packages which fail to import on readthedocs.org because

问题 I would like to change the background color of the Read the Docs theme for sphinx-doc. The theme is written using sass and I find the variable $section-background-color which is defined no-where. If I replace the #2980B9 with another value anywhere in the project, it doesn't work. This insane blue is still retrieved from somewhere. Where is this background color defined? I also tried to replace all the $blue with $red in _theme_variables_sass . 回答1: There are (at least) two ways to change

问题 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 working (thanks to a lot of help from this forum) but now I would like to include the docson widget to show my code more beautiful (https://global-coffee-data-standard.readthedocs.io/en/latest/explanation.html#id13) I've read this page https:/

问题 I try to use a custom theme inherited from Sphinx's built-in ReadTheDocs Theme. When I use it on my local computer I have the good design. But when I am on the read the doc version (imported from github) there is no CSS. Did I miss something? The repo with the branch using the custom theme: https://github.com/DigitalSkills-fr/Docs/tree/custom_theme/docs The doc on RTD with the targeted branch: http://digitalskills-docs.readthedocs.io/fr/custom_theme/index.html Thanks for any help. 回答1: You

问题 I have a public github repository. Following instructions at readthedocs, I used Sphinx to get the documentation in a form I'm happy for others to see. Edit your files and rebuild until you like what you see, then commit your changes and push to your public repository. Once you have Sphinx documentation in a public repository, you can start using Read the Docs. I've pushed all of that to my public repository at github. In particular, I have a docs.py and an index.rst file sitting within docs

问题 I'm writing a package that wraps PyQt5 functionality and trying to put the documentation on readthedocs. Since PyQt5 is an extension module I mock the module and its classes (manually, because using unittest.mock causes metaclass conflicts): class PyQt5: class QtCore: @staticmethod def qVersion(): return '5.0.0' class QObject: pass # etc sys.modules['PyQt5'] = PyQt5 This works fine locally. But although the builds pass without error on readthedocs, there is no autodoc output. What am I

问题 Pretty sure this isn't a dupe. my read docs build fails here: Collecting sphinxcontrib-inlinesyntaxhighlight==0.2 (from -r /home/docs/checkouts/readthedocs.org/user_builds/zproc/checkouts/latest/requirements.txt (line 33)) Using cached https://files.pythonhosted.org/packages/5c/8b/17998fe9ebbec7e176f344648a86094d7b358e63d8f4593ae3dfbb9bb560/sphinxcontrib-inlinesyntaxhighlight-0.2.tar.gz Complete output from command python setup.py egg_info: Traceback (most recent call last): File "<string>",

问题 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 sphinx-autodoc-annotation of course. I'm trying to generate the same documentation using Read the Docs, but it gives me an error: Could not import extension sphinx_autodoc_annotation (exception: No module named sphinx_autodoc_annotation) Is it possible to