Add some documentation in your package:
- a brief description
- readme headers
- list of authors
The examples associated with this option provide a scaffold for a more complete documentation in the doc directory:
- a basic index file
. | +-AUTHORS.rst | +-CONTRIBUTING.rst | +-HISTORY.rst | +-README.rst | +-doc/ | | | +-_static/ | | | +-nonempty.txt
You need to decide rapidly (aka before regenerating the package) the format you intend to use to write the documentation:
- Complete documentation of code, use the default ‘rst’ (only one that actually work with sphinx).
- webpages (aka user oriented documentation), then you can use ‘md’
Follow these steps to install this option and the associated files:
(dvlpt)$ pmg add doc (dvlpt)$ pmg rg
Meaning of pieces of information¶
Provided as an example file, a basic body for the readme file with different sections depending on the installed options. The README.rst file is regenerated automatically so out of reach. However, it simply add a few headers to a README_body file located in the ‘doc’ directory. We encourage you to modify this file to suit your needs.
An example file describing how people can contribute to the package is available as an example:
(dvlpt)$ pmg example doc
This file makes more sense if you already installed the ‘github’ or ‘gitlab’ option.