gitrepo-template

The absolute template

This gitrepo-template can be used as a template to create other GitHub repositories. It helps users to start a proper repository including files for Community (e.g., license and contributing guideline), as well as 'professional' documentation built with Sphinx.

---

Repository options

To let the user choose or tune the repository:

• the .gitignore file is empty;
• the license file is empty.

Building the documentation

The documentation is built with Sphinx, in the 'docs' folder. This way, the user can easily connect the GitHub repository to Read the Docs. The following features have been set:

• build and source folders are separated;
• the reStructuredText markup language is used to create the documentation;
• the configuration file (conf.py) sets the main basic options.