Skip to content

[SIGMON-543] use mkdocstrings instead of sphinx

Simon Mazenoux requested to merge SIGMON-543_mkdocstrings into dev

Context

  • Both mkdocs and sphinx were used to generate documentation:
  • The goal is to use the package mkdocstrings and remove sphinx doc generation for the API.
  • This will also unify the UI of the documentation instead of having one part of it using material theme and the other part having readTheDoc theme.

What was done

  • Remove any .rst file
  • Add API documentation using mkdocstrings

TODO

QA

  • code was not unit tested, because it's impossible to test basically
  • acceptance tests were written

Review objectives

  • assessment of code functionality
Edited by Simon Mazenoux

Merge request reports