This repo contains a skeleton for Python projects containing some basic DevOps´ components like CI/CD pipelines.
The code of this repo will be linted with PyLint automatically on each push and pull-request to ensure that the files are correctly formatted in order to improve readability.
You can add your tests in the test/ directory. By providing the prefix test_ the files will be recognized and executed by PyTest.
The documentation is created with the help of MkDocs Material, which generates html-based docs that is exposed via GitHub pages. In order to see the documentation, some configuration in GitHub needs to be done. Head to the repo´s settings and enable GitHub pages. Set the source to branch gh-pages. The documentation should now be hosted at http[s]:<username>.github.io/<repo-name>
In order to adapt the config, change the specifics in mkdocs.yml.
To manually build the documentation execute the following command:mkdocs build.
However, the documentation will be built automatically on each push and added to the repo by a GitHub Action - so you don´t have to generate it yourself each time.