Add docs and deploy

[emmuhamm]

Description

vibes

Fix #52
Fix #43

Add docs and deploy them. Its a lot.

There are two kinds of docs that exist, one for the user and one for the developer. The user docs are found in docs/ and the dev docs are in docs_dev/. The split is so that the user docs are used to make the dune daq readthedocs website, while the dev docs are primarily found in the mkdocs (similar to how it is in drunc).

Speaking of mkdocs, they should be found here: https://dune-daq.github.io/daqpytools/

It contains both the user and developer docs just so we have everything in one consistent place.

The docs themselves follow the diataxis framework, such that each page should be only one of the four: tutorial, guide, reference, explanation. That should make the reading and understanding of the docs much clearer. \

The api references are automatically generated, this is done using the dev_docs/generate_logging_autodocs.py script.

The other script in that file just cleans up the file structure in the two docs so they are clearly displayed in the mkdocs.

For this one feature to work, we have an empty folder called docs_anchor, which is eventually used to build the autodocs so that we have the user and dev docs in the same heirarchy.

Type of change

• Documentation (non-breaking change that adds or improves the documentation)

Testing checklist

View https://dune-daq.github.io/daqpytools/ and read through everything :')

• Unit tests pass (e.g. dbt-build --unittest)
• Minimal system quicktest passes (pytest -s minimal_system_quick_test.py)
• Full set of integration tests pass (daqsystemtest_integtest_bundle.sh)
• Python tests pass if applicable (e.g. python -m pytest)
• Pre-commit hooks run successfully if applicable (e.g. pre-commit run --all-files)

Comments here on the testing

Further checks

• Code is commented where needed, particularly in hard-to-understand areas
• Code style is correct (dbt-build --lint, and/or see https://dune-daq-sw.readthedocs.io/en/latest/packages/styleguide/)
• If applicable, new tests have been added or an issue has been opened to tackle that in the future.
  (Indicate issue here: # (issue))

[emmuhamm]

Hi @PawelPlesniak @henry-wallace-phys, this monster of a PR is ready for review. Might be easier to review if you just read the docs to be honest, which is found here: https://dune-daq.github.io/daqpytools/

@henry-wallace-phys since youre not too familiar with the logging framework, can you give comments on how clear and easy to follow the docs are? hopefully the tutorial and the how tos and the best practices should help you get up and running with your runconfui refactor :)

@PawelPlesniak since youre an expert, can you flick through everything? (sorry..) Let me know if im missing something svp