Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.<suffix>).
This is derived from the "sphinx-autopackage" script, which is: Copyright 2008 Société des arts technologiques (SAT), https://sat.qc.ca/
Unknown Field: copyright | |
Copyright 2007-2022 by the Sphinx team, see AUTHORS. | |
Unknown Field: license | |
BSD, see LICENSE for details. |
Constant | OPTIONS |
Undocumented |
Constant | PY_SUFFIXES |
Undocumented |
Variable | template_dir |
Undocumented |
Function | create_module_file |
Build the text of the file and write the file. |
Function | create_modules_toc_file |
Create the module's index. |
Function | create_package_file |
Build the text of the file and write the file. |
Function | get_parser |
Undocumented |
Function | has_child_module |
Check the given directory contains child module/s (at least one). |
Function | is_excluded |
Check if the directory is in the exclude list. |
Function | is_initpy |
Check filename is __init__ file or not. |
Function | is_packagedir |
Check given files contains __init__ file. |
Function | is_skipped_module |
Check if we want to skip this module. |
Function | is_skipped_package |
Check if we want to skip this module. |
Function | main |
Parse and check the command line arguments. |
Function | module_join |
Join module names with dots. |
Function | recurse_tree |
Look for every file in the directory tree and create the corresponding ReST files. |
Function | walk |
Walk through the directory and list files and subdirectories up. |
Function | write_file |
Write the output file for module/package <name>. |
Parameters | |
package:str | Undocumented |
basename:str | Undocumented |
opts:Any | Undocumented |
user_template_dir:str | Undocumented |
Parameters | |
modules:List[ | Undocumented |
opts:Any | Undocumented |
name:str | Undocumented |
user_template_dir:str | Undocumented |
Parameters | |
root:str | Undocumented |
master_package:str | Undocumented |
subroot:str | Undocumented |
py_files:List[ | Undocumented |
opts:Any | Undocumented |
subs:List[ | Undocumented |
is_namespace:bool | Undocumented |
excludes:List[ | Undocumented |
user_template_dir:str | Undocumented |
Parameters | |
rootpath:str | Undocumented |
excludes:List[ | Undocumented |
opts:Any | Undocumented |
Returns | |
bool | Undocumented |
Check if the directory is in the exclude list.
Parameters | |
root:str | Undocumented |
excludes:List[ | Undocumented |
Returns | |
bool | Undocumented |
Parameters | |
filename:str | Undocumented |
Returns | |
bool | Undocumented |
Parameters | |
dirname:str | Undocumented |
files:List[ | Undocumented |
Returns | |
bool | Undocumented |
Parameters | |
filename:str | Undocumented |
opts:Any | Undocumented |
excludes:List[ | Undocumented |
Returns | |
bool | Undocumented |
Parameters | |
dirname:str | Undocumented |
opts:Any | Undocumented |
excludes:List[ | Undocumented |
Returns | |
bool | Undocumented |
Parameters | |
argv:List[ | Undocumented |
Returns | |
int | Undocumented |
Parameters | |
*modnames:str | Undocumented |
Returns | |
str | Undocumented |
Parameters | |
rootpath:str | Undocumented |
excludes:List[ | Undocumented |
opts:Any | Undocumented |
user_template_dir:str | Undocumented |
Returns | |
List[ | Undocumented |