Vberenz/mkdocs

[vincentberenz]

Added mkdocs structure, and refactored the docstrings (and applied black)

to install the dependencies for documentation building:

pip install -e ".[docs]"

To see the doc:

mkdocs serve

This starts a live server. Modifications of the documentation are rendered live (excluded the modications to docstrings)

To build the docs:

mkdocs build

this will create the site folder (including index.html)

To expend the docs:

Markdown files can be added in the docs folder, then the "nav" section of the mkdocs.yml file has to be updated, e.g.

nav:
  - about: index.md
  - API: references.md
  - my other page: mymarkdown.md

• good to know: markdown can be used in the docstrings.
• apparently, deploying the documentation online on github after built is as simple as calling mkdocs gh-deploy (I did not try it yet)

I still need to do:

• continuous build on github (documentation is rebuilt and deployed at each merge into master)
• a correction pass on the docstrings (I updated them, but did not check them one by one yet)
• the layout is not so nice (especially for the API), needs to be improved
• apparently mkdocs allows to display jupyter notebooks, I need to dig

[VincentStimper]

Looks great, thanks! You are welcome to merge it now.