read-the-docs

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 configure Read the Docs to work with sphinx-autodoc-annotation, and if so, how do I make it work? Activate

I am currently in the process of getting the documentation of my code online via read-the-docs, however, getting read-the-docs to process my PyQt4 dependent modules seems problematic. My project has the following structure: pkg pkg/__init__.py pkg/modules/ pkg/modules/__init__.py pkg/modules/somemodules.py pkg/gui/__init__.py pkg/gui/someGUImodules.py I am using sphinx-autodoc to build a html representation of the docstring of the different modules. On my local machine everything works fine, however, since I need to mock PyQt4 on read-the-docs, I ran into the following problem: In one of my

I'm trying to document a Python project with ReadTheDocs. Initially, the build process would die when it got to: from osgeo import gdal, osr I've read the rtd faq and used mock for the osgeo module that was giving me trouble. Now the build process makes it past that import but chokes on: from osgeo.gdalconst import * With this rather unhelpful error: RuntimeError: sys.path must be a list of directory names I'm completely new to using mock but I think the problem is that osgeo is a mock module and therefore does not have the submodule gdalconst . How do I get around that? Is there a way to mock

It's my understanding the new Read The Docs theme generates the sidebar from the toctree with a depth of 2. My documentation is relatively deep, and a depth of 2 is not enough for it to be useful. How can I increase this limit, or preferably remove it entirely? If that's not reasonably possible, how can I use local ToC's instead of the global toctree? Note: The previous answer was outdated. As @Ariel notes in a comment, the maxdepth is now configurable by setting navigation_depth in html_theme_options . As per the README , change this in your project's conf.py: html_theme_options = {

I'm building documentation for my API library and I'm having readthedocs.io host the documentation, and is backed with Sphinx. I have the Read The Docs theme installed for Sphinx using pip install , and the Read the Docs website currently has the documentation running. I would like to change the colors of my documentation. I have done some searching through their GitHub repository GitHub.com and have seen some talk that editing the sass files. However, I can't seem to find where these files are located. Example of a Read The Docs with other colors Any help is appreciated! I believe the