基于ReadTheDocs站点的文档主题定制问题咨询

Great questions—let’s break down each of your requests and how to implement them on Read the Docs (RTD):

1. Enable Text Wrapping in Tables #

This absolutely works for RTD-hosted docs, and you have two straightforward ways to fix the horizontal scrolling issue:

Option 1: Custom CSS #

Create a custom.css file in your project’s _static/css/ directory (create the folders if they don’t exist), then add this rule:

table.docutils {
    white-space: normal !important;
}

Next, update your conf.py to load this custom stylesheet:

# Path to static files (ensure this line exists)
html_static_path = ['_static']

# Add custom CSS
html_css_files = ['css/custom.css']

Option 2: Theme Configuration (Sphinx 4.0+) #

If you’re using a newer version of the sphinx-rtd-theme, you can set the table_style option directly in conf.py:

html_theme_options = {
    'table_style': 'normal'
}

This tells the theme to use natural text wrapping instead of forcing single-line tables with scrollbars.

2. Restore the Online Index (Genindex) #

The Sphinx genindex is fully supported on RTD—you just need to ensure it’s visible in your navigation. By default, the RTD theme tucks it under an "Indices and tables" dropdown, but if you want a direct link, update your conf.py to modify the sidebar:

html_sidebars = {
    '**': [
        'globaltoc.html',
        'localtoc.html',
        'searchbox.html',
        'genindex.html'  # Adds the index link to the sidebar
    ]
}

This will make the genindex easily accessible to your code-focused audience, matching its utility in the PDF version.

3. Restore the Module Index (Modindex) #

First, confirm you have the required extension enabled in conf.py (it’s needed to generate the module index):

extensions = [
    # ... other extensions you’re using ...
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode'  # Optional, but adds useful source code links
]

Then, add the module index to your sidebar just like the genindex:

html_sidebars = {
    '**': [
        'globaltoc.html',
        'localtoc.html',
        'searchbox.html',
        'genindex.html',
        'modindex.html'  # Adds the module index link
    ]
}

As long as you’re using directives like automodule to document your Python modules, the modindex will populate with content and be available on your RTD-hosted docs.

All these changes work for both local builds and RTD-hosted docs—RTD uses your project’s conf.py and static assets directly, so your customizations will carry over when you push updates.

内容的提问来源于stack exchange，提问作者bht