code-for-venezuela / c4v-py

3 stars 3 forks source link

Luis/docs #94

Closed LDiazN closed 3 years ago

LDiazN commented 3 years ago

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 friendly

Relevant files

Further work

Edilmo commented 3 years ago

Please check if the PR https://github.com/code-for-venezuela/c4v-py/pull/54 should be used (and merge) before this one, or if this PR already cover the content there in which case we could archive it.