Version latest

ReStructured Text Configuration

Add the following content to the conf.py file a RestructuredText file is used as source, and fill the empty values.

  • project - will be the title of the documentation

  • master_doc is the the filename of the documentation without the file type postfix

conf.py content:

Default  
project = 'ReStructuredText Examples'
copyright = ''  #unused
release   = ''  #unused
version   = ''  #unused

extensions = [
    'sphinx.ext.duration',
    'sphinx.ext.doctest',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.intersphinx',
    'myst_parser',
    'sphinxcontrib.openapi',
    'sphinx_tabs.tabs'
]

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'restructuredtext',
    '.md': 'markdown',
}

master_doc = ''

Example

Default  
project = ''
copyright = ''  #unused
release = ''    #unused
version = ''    #unused

extensions = [
    'sphinx.ext.duration',
    'sphinx.ext.doctest',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.intersphinx',
    'myst_parser',
    'sphinxcontrib.openapi',
    'sphinx_tabs.tabs'
]

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'restructuredtext',
    '.md': 'markdown',
}

master_doc = 'index'
Last updated: Feb 3, 2025
Need help?Contact Support
Questions?Contact us