Project Documentation Generation Script (tendril-gendox
)¶
This script (re-)generates all the documentation linked to recognized projects based on the criteria specified by the command parameters.
See also
Output Folders
The underlying functions generate the docs in the folder specified by the
REFDOC_ROOT
configuration option from tendril.utils.config
. This
folder may be configured by your instance’s instance_config.py
file to
point to a remote filesystem.
If you would like to generate the documentation on your local filesystem
instead, you should override the instance’s REFDOC_ROOT
configuration
parameter by setting it to a folder on your local filesystem in your
local_config_overrides.py
file.
Warning
It is strongly recommended to have this folder outside of the normal project tree, in order to prevent the generated documentation (which is mostly in binary file formats) from littering your VCS working folders.
Script Usage
(Re-)Generate gEDA project documentation.
usage: tendril-gendox [-h] [--version] [--force] [--dry-run] [--recurse]
[--all] [--include-suspended] [--include-deprecated]
[--include-archived] [--include-discarded]
[PATH [PATH ...]]
- Positional arguments:
projfolders gEDA Project Folder(s), ignored for –all. - Options:
--version show program’s version number and exit --force, -f Regenerate documentation even if it seems to be up-to-date --dry-run, -n Dry run only. Don’t do anything which can change the filesystem --recurse, -r Recursively search for projects under each provided PATH. --all, -a All recognized projects. --include-suspended, -iu Include suspended projects. --include-deprecated, -ip Include deprecated projects. --include-archived, -ir Include archived projects. --include-discarded, -is Include discarded projects.
-
tendril.scripts.gendox.
_get_parser
()[source]¶ Constructs the CLI argument parser for the tendril-gendox script.