# [__{namespace_name}__ ({project_name}) project](https://{namespace_name}.readthedocs.io): {project_desc}

## {namespace_name} namespace root package use-cases

this project is maintaining all the portions (modules and sub-packages) of the {namespace_name} namespace to:

* update and deploy common outsourced files, optionally generated from templates
* merge docstrings of all portions into a single combined and cross-linked documentation
* publish documentation via Sphinx onto [ReadTheDocs](https://{namespace_name}.readthedocs.io "{namespace_name} on RTD")
* refactor multiple or all portions of this namespace simultaneously using the grm portions actions

this root package is only needed for development tasks, so never add it to the minimal requirements file
({REQ_FILE_NAME}) of any project.

to ensure the update and deployment of outsourced files generated from the templates provided by this root package via
the [git repository manager tool](https://github.com/degroup/de_git_repo_manager), add this root package to the
development requirements file ({REQ_DEV_FILE_NAME}) of a portion project of this namespace.

the following portions are currently included in this namespace:

{portions_pypi_refs_md}

