Skip to content

docs: improve documentation#263

Merged
leahaeusel merged 2 commits intoqueens-py:mainfrom
leahaeusel:improve-documentation
Dec 15, 2025
Merged

docs: improve documentation#263
leahaeusel merged 2 commits intoqueens-py:mainfrom
leahaeusel:improve-documentation

Conversation

@leahaeusel
Copy link
Copy Markdown
Member

Description and Context:
What and Why?

This PR improves our documentation by:

  • displaying the __init__() methods in the documentation (the information in these docstrings was not visible in the documentation so far)
  • removing the tab 'queens packages' from the main menu in the top bar (Is redundant because of the 'Packages' tab):
    Before:
grafik After: grafik
  • placing the types indicated by type hinting where the types from the docstrings are (makes function signature more easily readable):
    Before:
grafik After: grafik
  • fixing bugs in the docstrings which sphinx complained about but we silently ignored so far (mostly related to lists)
  • updating the instructions on how to build the documentation locally
  • updating the onboarding tutorial
  • removing doc/source/_ext/templates/1-monte_carlo_uq.rst.j2, which is no longer needed

Related Issues and Pull Requests

  • Closes
  • Related to

Interested Parties

Note: More information on the merge request procedure in QUEENS can be found in the Submit a pull request section in the CONTRIBUTING.md file.

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants