Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 949 Bytes

File metadata and controls

34 lines (22 loc) · 949 Bytes

TemplatePythonPackage

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

Installation

pip install https://github.com/LenaSchn/packagepythoncourse/zipball/main

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

image

  1. 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.

image