We need a way to provide online documentation for both users and collaborators. It should easy to edit & update with the CI in order to reduce the amount of work to keep it up to date.
Solution
We added mkdocs as a dependency to create our documents and added a few pages and the initial layout for the documentation.
You can preview the current documentation page here.
Also, we provided the proper configuration in the github CI to keep it up to date whenever there's a push to master.
Additional changes
Some refactors in the main object microscope.Manager to make it more user friendly
Relevant files
docs - This entire folder contains the files required by mkdocs to build the website, including some documentation pages
src/microscope/manager.py - Changes to the API so it's easier to use
.github/worflows/ - Folder with new worflows for the publishing github actions
Problem
We need a way to provide online documentation for both users and collaborators. It should easy to edit & update with the
CI
in order to reduce the amount of work to keep it up to date.Solution
We added mkdocs as a dependency to create our documents and added a few pages and the initial layout for the documentation.
You can preview the current documentation page here. Also, we provided the proper configuration in the github CI to keep it up to date whenever there's a push to master.
Additional changes
Some refactors in the main object
microscope.Manager
to make it more user friendlyRelevant files
docs
- This entire folder contains the files required by mkdocs to build the website, including some documentation pagessrc/microscope/manager.py
- Changes to the API so it's easier to use.github/worflows/
- Folder with new worflows for the publishing github actionsFurther work