This PR adds a documentation website in materials mkdocs format, which replaces the old pdf manual and the ipynb tutorials.
Why
The old documentation was difficult to find and to maintain with future version changes.
Adding web content for CLEESE will improve search engine results.
It has proved unconvenient for beginning python users to install/start jupyter notebook to access a tutorial
This provides a template for other documentation websites in the team's other toolboxes, such as palin or revcor/jones
How
The documentation website is built with the materials for mkdocs framework, and hosted in the /docs folder in the repo. Upon push/PR to the main branch, it is automatically built and deployed on the gh-pages branch, using the .github/workflows/ci.yml workflow.
Testing
When updating documentation, it is possible to test changes locally before deploying by running
mkdocs serve from the cleese/docs directory.
What
This PR adds a documentation website in materials mkdocs format, which replaces the old pdf manual and the ipynb tutorials.
Why
How
The documentation website is built with the materials for mkdocs framework, and hosted in the
/docs
folder in the repo. Upon push/PR to themain
branch, it is automatically built and deployed on thegh-pages
branch, using the.github/workflows/ci.yml
workflow.Testing
When updating documentation, it is possible to test changes locally before deploying by running
mkdocs serve
from the cleese/docs directory.