python3-pip-skeleton

Code CI Docs CI Test Coverage Latest PyPI version Apache License

Note

This project contains template code only. For documentation on how to adopt this skeleton project see https://DiamondLightSource.github.io/python3-pip-skeleton-cli

This is where you should write a short paragraph that describes what your module does, how it does it, and why people should use it.

PyPI

pip install python3-pip-skeleton

Source code

https://github.com/DiamondLightSource/python3-pip-skeleton

Documentation

https://DiamondLightSource.github.io/python3-pip-skeleton

Releases

https://github.com/DiamondLightSource/python3-pip-skeleton/releases

This is where you should put some images or code snippets that illustrate some relevant examples. If it is a library then you might put some introductory code here.

Or if it is a commandline tool then you might put some example commands here.

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

How-to Guides

Practical step-by-step guides for the more experienced user.

Explanations

Explanation of how the library works and why it works that way.

Reference

Technical reference material including APIs and release notes.

About the documentation

Why is the documentation structured this way?