Auto class diagrams in the drunc docs

[emmuhamm]

Description

Fixes issue #663

Add auto class diagram construction and expose to the public.

DUNE-DAQ/daqpytools#66 needs to have been merged before this can go in

The above merge request adds in the nice feature of daqpytools-generate-uml, which allows us to generate any uml diagram for any python repository !

This one implements this in drunc. This generates a whole lot of files, but we also want to expose this. Because of this, its not a good idea to have a github action that saves the pngs in the repository itself.

What can work, however, is by injecting this into the mkdocs website!

This PR adds the ability to have galleries in the MKDocs page, as well as use the daqpytools cli tool to generate the required images.

The name of the 'gallery' will still have to be decided though

Type of change

• Documentation

List of required branches from other repositories

DUNE-DAQ/daqpytools#66

Suggested manual testing checklist

Read the website

Developer checklist

Prior to marking this as "Ready for Review"

Tests ran on: WHAT HOSTNAME from release RELEASE_NAME

Unit tests - some tests can't be ran on the CI. This is documented. If this PR checks a feature that can't be tested with CI, this has been marked appropriately.

Integration tests - the daqsystemtest_integtest_bundle requires a lot of resources, and connections to the EHN1 infrastructure. Check the cross referenced list if you can't run these. The developer needs to run at least the .

• Unit tests (pytest --marker) passed
  • With relevant marker
  • Without marker
• Integration tests passed
  • Only daqsystemtest_integtest_bundle.sh -k minimal_system_quick_test.py
  • Full daqsystemtest_integtest_bundle.sh
• Testing skipped as there are no core code changes in this PR, this only relates to documentation/CI workflows

Final checklist prior to marking this as "Ready for Review"

• Code is clearly commented.
• New unit tests have been added, or is documented in # ISSUE NUMBER
• A suitable reviewer has been chosen from this list.

Reviewer checklist

• This branch has been rebased with develop prior to testing.
• Suggested manual tests show changes.
• CI workflows fails documented (if present)
• Integration tests passed
  • Only concern yourself if failures related to drunc are in the log files
  • If non-drunc failure appears:
    • Validate failure in fresh working area
    • Contact Pawel if unsure

Once the features are validated and both the unit and integration tests pass, the PRs is ready to be merged.

Prior to merging

Choose one of the following an complete all substeps

• Changes only affect the Run Control, are in a single repository, and do not affect the end user.
  • Changes are documented in docstrings and code comments
  • Wiki has been updated if architectural or endpoint changes
• Otherwise
  • Workflow changes demonstrated in the Change Log (if necessary)
  • Wiki has been updated (if necessary)
  • #daq-sw-librarians Slack channel notified (see below)

Once completed, the reviewer can merge the PR.

Notification message for a Slack channel

Note - this should be to #dunedaq-integration for general workflow that isn't during a release candidate period, and to #daq-release-prep otherwise.

For an single merge that changes the user workflow

The CCM WG has an isolated PR ready to merge that affects user workflows. The PR is:

_URL_

I will leave time for any comments, otherwise will merge these at the end of the work day _Insert your time zone_.

For co-ordinated merge

The CCM WG has a set of co-ordinated merges ready to merge. The PRs are:

_URL_

_URL_


I will leave time for any comments, otherwise will merge these at the end of the day.

[emmuhamm]

[emmuhamm]

now you need to refactor context_settings from generate_uml from logging...

[emmuhamm]

(as of c6a6d96) IT WORRKKS

Gonna take this down for now. But if you want to view it just run the deploy docs github action on this branch.

The git history is gonna need a helluvalot of cleaning, and also probably some of the pathing and stuff, but hey its amazing and it works

[emmuhamm]

@PawelPlesniak this is technically blocked by DUNE-DAQ/daqpytools#66 but this is ready for review.

As it stands, you can see the effect of this if you rerun the deploy docs action you should be able to see it live. However, before it gets merged, the one comment I have should be implemennted so it points to the develop branch of daqpytools

[emmuhamm]

DUNE-DAQ/daqpytools#66 has gone in so I'll undraft this. Its ready for review, although theres a few points I've already flagged up for discussion