Python Tools & Skills

Distribution (Documentation)

Dr. Yves J. Hilpisch | The Python Quants GmbH

Certificate Programs, November 2021

(short link to this Git repository: http://bit.ly/ts_docu)

Slides

You find the slides under:

https://certificate.tpq.io/tools_skills_dist.pdf

Docker Container

Using a Docker container should simplify working with the tools presented in this part of the class. You should clone the Git repository via

git clone --depth=1 https://github.com/yhilpisch/documentation

Then navigate to the folder of the Git repository (documentation) and run:

docker run -ti -h tools -p 9999:9999 -v $(pwd):/root/git ubuntu:latest /bin/bash

In the Docker container, to install the tools required execute:

cd /root/git
bash install.sh

pylib — Documentation

This is the rather simplistic documentation example from the Tools & Skills class of The Python Quants.

Package

The package documented contains a total of three simple Python files, two of which are in sub-folders/sub-packages, with a single function each.

Training

In addition to the package files, the Git repository contains also other files used for the training session.

Slides are found under http://hilpisch.com/tools_skills_dist.pdf.

Documentation

Sphinx

The Sphinx package represents a standard in Python documentation. See e.g. http://www.sphinx-doc.org and http://www.sphinx-doc.org/en/stable/tutorial.html.

A valuable add-on is the nbsphinx extension which allows you to directly include Jupyter Notebook files into your documentation. See https://nbsphinx.readthedocs.io.

Environment

On the shell, create an environment with conda:

conda create -n docu-pylib python=3.9 ipython jupyter pandoc
conda activate docu-pylib
pip install sphinx nbsphinx

Build the Documentation

Clone the Github repository to your local working folder:

git clone http://github.com/yhilpisch/documentation

Navigate to the repository folder and execute a doctest as well as build the documentation:

cd documentation

Uncomment in pylib/mod.py the following code

>>> # from pylib import *

Execute the doctest:

make doctest

Build the HTML documentation:

make html

The HTML documents are found in _build.

First Steps

Start a Python interactive session session and e.g. execute:

>>> import pylib
>>> pylib.one(10)
10
>>> pylib.two(20)
40
>>> pylib.three(3)
9

Copyright

The material is copyright (c) Dr. Yves J. Hilpisch | The Python Quants GmbH. MIT License.