TemplatePythonPackage

A template for a minimal Python package with a automated documentation website.

Installation

pip install https://github.com/floramouj/templatepythonpackage

Example

import TemplatePythonPackage as mypackage

mypackage.joke()

Other examples can be found here:

• link

How to use this template

1. Create a new repo based on this template by clicking on "Use this template"
2. Wait a fews minutes until the automatic documentation builder becomes green

3. Enable the website:

• Go to your repo's "Settings"
• "Pages" -> change the branch to gh-page (the builder must be finished for that branch to appear)
• Save and copy the name of your website.