Skip to content

[Documentation] Introduce mkdocs and add new documentation pages

Karim Ahmed requested to merge doc/mkdocs_new_documentations into master

New pycalibration documentation

The idea is to use markdown for the documentation and renovate all of the documentation. There is a lot of outdated text and a lot of missing information.

The current branch results can be found on RTD at https://rtd.xfel.eu/docs/european-xfel-offline-calibration/en/doc-mkdocs_new_documentations/

Description

  • Update files from rst to markdown.
  • add the mkdocs pieces:
    • mkdocs.yml
    • update requirements.txt
  • Start adding new documentation e.g. for CALCAT and myMDC.
  • Update outdated documentation.
  • Generate markdown files for functions(autodoc). As we are not using Google style the result as not as I preferred.
    • I either find a way to show the docstrings in a better way as it was shown using sphinx.
    • We update our docstrings style to Google. (calcat_interface and cal_tools.files are already using it.)

How Has This Been Tested?

https://rtd.xfel.eu/docs/european-xfel-offline-calibration/en/doc-mkdocs_new_documentations/

Relevant Documents (optional)

Types of changes

  • Docs (changes to the documentation)

Checklist:

Reviewers

Edited by Karim Ahmed

Merge request reports