MkDocs documentation for ReadTheDocs

[asiomchen]

This pull request includes several updates to the documentation, configuration files, and contribution guidelines. The most important changes include adding a new Read the Docs configuration file, updating the CONTRIBUTING.md file with new instructions, and modifying the .pre-commit-config.yaml file to exclude .ipynb files from certain checks.

Documentation Updates:

Documentation should be good to go, docstring can still be improved, but this is good starting point.
Last step is to deploy the docs will be to activate RTD build, once PR is merged

• Added MkDocs documentation for API and notebooks
• Added a new Read the Docs configuration file (.readthedocs.yaml) to set up the documentation build environment and process.
• Moved notebooks and their .py files to to separate folders, so the ipynb-py pair can be paired automatically

Configuration Updates:

• Modified .pre-commit-config.yaml to exclude .ipynb files from the pretty-format-json check.

Code Ownership:

• Updated .github/CODEOWNERS to assign specific files to their respective owners.

Build and Testing:

• Added new Makefile targets for syncing and running notebooks.

These changes aim to improve the documentation process, streamline the contribution workflow, and ensure proper code ownership and formatting.

[EBjerrum]

Looks very good. There's two minor things I stumbled upen when looking through the docs. I commented on the relevant files.

Some of the doscstrings will need a bit of TLC (e.g. ,SECFingerprintTransformer) but I guess it gets easier to spot and correct once we get this doc system up and running, so that can come over time.

Just a question: After things are set up, the docs will be live on mkdocs? then _doc_link_template and _doc_link_url can be implemented on the classes.

[asiomchen]

Yeah, it will be much more convenient to work on docstrings once the docs deployment is enabled.
And yes _doc_link_url is worth adding after we 100% have the live docs and base URL claimed.

The docs will be live on ReadTheDocs - I already tested deployment on my fork and it works fine.

So after the PR will be merged what is left is to import project to RTD. It is simple and mostly automatic process.
Btw, do you prefer to do it yourself or I can handle it?

[EBjerrum]

Sounds great. You are welcome to put it live on RTD, sound like you already know what to do. But, can I also get administrator rights to the deployment there?