sjev/python-quick-start

Example for starting new python projects. Data science oriented.

Python quick start

Example project for creating a module with a good structure, documentation and testing

The conf.py file has been generated with sphinx-autostart and then edited by hand.

Additions and comments are welcome!

Resources

• Sample Doc Quick example of rst usage
• RST primer More extensive primer of rst synthax
• numpy style guide

Building docs

1. install required packages with pip install -r requirements.txt
2. run make html in the doc folder

Publishing on github pages (optional)

The pages can be published on github, either on a special branch named gh-pages or in a subfolder docs on the main branch. Using docs folder is the most convenient approach.

1. create docs folder and use it as a target for sphinx build.
2. create a .nojekyll file, otherwise pages and directories starting with underscore will be ignored
3. build and commit the docs

The docs for this project are published here.