neuro-team-femto / cleese

Combinatorial Expressive Speech Engine
MIT License
42 stars 10 forks source link

Docs as mkdocs #23

Closed jjau closed 4 months ago

jjau commented 4 months ago

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 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.

review-notebook-app[bot] commented 4 months ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB