I have a Python module that contains many .py files:
(pyuvm_dev) (base) raysalemi@RayProMac docs % ls ../pyuvm
__init__.py s08_factory_classes.py s17_uvm_reg_enumerations.py s23_uvm_reg_item.py
__pycache__ s09_phasing.py s18_uvm_reg_block.py s24_uvm_reg_includes.py
error_classes.py s12_uvm_tlm_interfaces.py s19_uvm_reg_field.py s25_uvm_adapter.py
extension_classes.py s13_predefined_component_classes.py s20_uvm_reg.py s26_uvm_predictor.py
s05_base_classes.py s13_uvm_component.py s21_uvm_reg_map.py s27_uvm_reg_pkg.py
s06_reporting_classes.py s14_15_python_sequences.py s22_uvm_mem.py utility_classes.py
(pyuvm_dev) (base) raysalemi@RayProMac docs %
I would like sphinx to document all of them, so I’ve done the following:
Created a pyuvm.rst file
My pyuvm.rst
file explicitly calls out the first submodule.
pyuvm
=====
.. currentmodule:: pyuvm
.. autosummary::
:toctree: generated
s05_base_classes
And I have this in conf.py
<snip>
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary'
]
<snip>
This gives me an HTML page with one module document.
How can I get Sphinx to document all the files in this directory without explicitly listing them?