rail.utils.interactive.apidoc_utils module
Functions to create rst stubs of api documentation for the rail.interactive module.
- rail.utils.interactive.apidoc_utils.add_to_recursive(name)
Function used to populate a recursive dict of rail.interactive submodules
- Parameters:
name (str)
- Return type:
None
- rail.utils.interactive.apidoc_utils.get_children(parts)
Get a list of submodules of some specific rail.interactive module
- Parameters:
parts (list[str])
- Return type:
list[str]
- rail.utils.interactive.apidoc_utils.get_extra_content(name, docs_path)
Fetch any descriptive rst content written for this module
- Parameters:
name (str)
docs_path (Path)
- Return type:
str
- rail.utils.interactive.apidoc_utils.make_rst(name, children, docs_path)
Write an rst file for a rail.interactive module
- Parameters:
name (str)
children (list[str])
docs_path (Path)
- Return type:
None
- rail.utils.interactive.apidoc_utils.write_interactive_api_rst(docs_path)
Write rst api files for the rail.interactive module and associated submodules
The default RailEnv api writer doesn’t understand the dynamically created submodules for interactive. Additionally, we need the :imported-members: rst directive for autodoc in order to actually render the interactive functions.
- Parameters:
docs_path (str) – docs directory where Sphinx is run from
- Return type:
None