Improve documentation

[gilrrei]

Description and Context

This PR improves documentation by adding information from the README.md, CONTRIBUTING.md and tests/README.md . Also, links to the repo and website are added.

Ok this PR escalated a bit, so here is a list of changes:

• Logos are added to the doc folder. This way everything works offline and users won't be redirected to any other page. At documentation builds, new logos will be pulled, and this should be added to the update workflow that is incoming
• I generalized the marker in markdown approach to be able to extract sections from markdown files to the documentation. Still not sure if this is genius or madness. Tbh it works pretty stable
• There now is a Development tab that includes the contents of the testing README and Contributing such as installing, license etc
• The architecture overview was renamed into modules overview. Here, the module description found in queens_subpackage/__init__.py is added. So no need to maintain a separate description. On this, I updated the descriptions a bit, but feedback is welcome.
• The QUEENS example in the readme is added to the tutorial's example
• I introduced a custom sphinx extension that basically just calls a python script that builds the prerequisites for the documentation mentioned above
• The custom script mostly gathers information from different sources and based on jinja templates creates the files for sphinx to generate the HTML with
• I introduced the sphinx extension myst_parser, which allows adding markdown files besides rst.

Thanks to @leahaeusel's PR you can preview the HTML documentation by downloading the artifact from the documentation build

Related Issues and Pull Requests

• Closes
• Blocks
• Is blocked by
• Follows
• Precedes
• Related to
• Part of
• Composed of

How Has This Been Tested?

Checklist

• My commit messages mention the appropriate issue numbers (advised but optional).
• I mention the appropriate issue numbers in this PR.
• I updated documentation where necessary.
• I have added tests to cover my changes.

Additional Information

Interested Parties

Possible reviewers:

Other interested parties:

[gilrrei]

The reason for introducing the custom extension to extract information from different places is to avoid maintaining the same information in various places in QUEENS. The goal was to have as much information as possible in the source code, such that on changes, renaming, moving the to different locations, the documentation should still work

[mayrmt]

@gilrrei I was curious, so I had a look... while at it, I left some comments...

[gilrrei]

@gilrrei I was curious, so I had a look... while at it, I left some comments...

Thanks, I added your suggestions.

[leahaeusel]

Thank you very much for cleaning up the documentation and implementing the new copying features! This will hopefully save us a lot of work in the future.

[gilrrei]

@queens-py/maintainers I "rewrote" the module descriptions as they are actively used in the documentation and needed the typical module description layout. Since this is a hot topic, I propose to keep the definitions as they currently are and go over them in the next developer meeting to finish this MR.

[gilrrei]

@queens-py/maintainers I "rewrote" the module descriptions as they are actively used in the documentation and needed the typical module description layout. Since this is a hot topic, I propose to keep the definitions as they currently are and go over them in the next developer meeting to finish this MR.

See #105