I have a three-layered class structure like this: class Super(object): """This class is documented.""" class Intermediate(Super): pass class Sub(Intermediate): """This is also documented.""" ...

I'm trying to get started with Sphinx and seem to have relentless problems. Command: docs/sphinx-quickstart I answer all the questions and everything works fine. Command: docs/ls Everything looks n...

I am trying to install sphinx on a remote machine. Since I don't have an access to the root, I did this: $bash $mkdir -p ~/local/lib/python2.7/site-packages $export PYTHONPATH=$PYTHONPATH:~/lo...

I am trying to create a properly nested list using the following code (following Sphinx and docutils docs): 1. X a. U b. V c. W 2. Y 3. Z I expect this to result in two OLs but I get the fo...

I have a list item in my rst file that I would like to put a literal block into, but I am unable to get the literal block to end properly. This is my rst: 1. Item 1 (not literal) 2. Item 2:: My...

I want to do multiple versions of a documentation, which differ in the sections that are included. To achieve this I would usually use either the only directive or the ifconfig extension. However, ...

I'm using Sphinx to document one of my projects, and I like to preview my changes in my browser. I want to be able to save some changes to an .rst file, and be able to immediately refresh my browse...

I'm trying to use Sphinx to document a 5,000+ line project in Python. It has about 7 base modules. As far as I know, In order to use autodoc I need to write code like this for each file in my proje...

I am trying to automatically create api docs for a large python codebase using Sphinx. I have tried using build_modules.py and sphinx-apidoc. With either one, I can get rst docs successfully creat...

In Sphinx I get a ton of warnings like: /PATH/FILENAME:LINE: WARNING: duplicate label LABELNAME, other instance in /PATH/FILENAME It seems to see all section titles as "label"s and there...

For a programming language documentation project written in reStructuredText and rendered to HTML with Sphinx, I want to group my functions into logical groups like: String (all string functions), ...

I'm getting the warning: WARNING: document isn't included in any toctree for files that exist in the document because they've been explicitly included. So I have the index file: .. toctree:: :max...

Is there any way to mark a class and/or method as deprecated in Sphinx? I can only find a deprecated option for modules. Using a generic admonition would work, but wouldn't carry the semantic mean...

I'm relatively new to using Sphinx and I've encountered an issue that I'm struggling to solve. I suspect the error might be related to the version of Sphinx I'm using, but attempts to resolve it wi...

I am writing the API document for my own project. And I found that this cool documentation (yt project) uses ipython notebook directly to give example. When I looked into their documentation repo ...

It is possible to make work mermaid inside \.md file with MyST md driver ? For now the only way I found is $ tail conf.py extensions = [ 'recommonmark', 'sphinxcontrib.mermaid'] from recommonmark.t...

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 t...

I am using Sphinx for generating docs for a python project. The output html is not preserving the line breaks which are present in the docstring. Example: Code def testMethod(arg1,arg2): """ Th...

Followed this link to try and generate pdf from Sphinx: https://www.quora.com/How-to-create-a-PDF-out-of-Sphinx-documentation-tool $ sphinx-build -b pdf source build/pdf Error: Cannot find sourc...

I am using Sphinx to document a Python project, which has the structure tree depicted below. calculator | set_rho_and_f.py | set_rho_and_V_dot.py | ├───data │ ├───fans │ │ ... │ │ │ ├───functions │...

I'm generating html documentation in Sphinx. How do I modify the sidebar for each of the html pages in my document so that they include the toctree? By default the toctree only seems to display in...

How can I cross-reference an indexed item inside a reStructuredText document? For example, how can I cross-reference SectionB: .. index:: pair: SectionA; SectionB SectionB -------- SectionB de...

I am using sphinx and was trying to generate documentation for my Django project. I decided to first try to document the models so in my .rst file I did this wdland\.models ============== .. auto...

I wrote a little module and I would like to know what are the basic steps to package it in order to upload it to PyPI: What is the file hierarchy? How should I name files? Should I use distutils t...

I have a package I would like to document with sphinx. The package consists of a few native modules (generated using boost-python) and an __init__.py The __init__.py does a bunch of (documented) m...