Welcome to PythonTemplatePackage’s documentation!

You can include code as part of the documentation

>>> print("Hello World")
Hello World

which can be tested by running make doctest. This is also run by the GitHub action to build the documentation.

You can also include executable example files with code and text, which are shown in the PythonTemplatePackage Gallery. The test_examples.py unittest automatically runs these examples to check for errors.

class pythontemplatepackage.myclass.MyClass[source]
some_function(param1, param2)[source]

Documentation for this function…

Parameters:
  • param1 – info on param1

  • param2 – info on param2