Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/#274 improve rtd doc #298

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from
Open

Conversation

maike93he
Copy link
Collaborator

Examples from the documentation (Minimum working exampes and Usage details) are now automatically tested within the notebook 'edisgo_documentation_examples.ipynb' which is integrated in test_examples.py

Fixes #274

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • New and adjusted code is formatted using the pre-commit hooks
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

… in test_examples.py

The notebook will be filled with examples from the documentation to automatically test if the examples work correctly.
…otebook

Examples from the documentation (Minimum working exampes and Usage details) are now automatically tested within the notebook
@maike93he maike93he requested a review from khelfen September 9, 2022 06:56
@maike93he maike93he requested a review from birgits September 11, 2022 14:34
@birgits
Copy link
Collaborator

birgits commented Jan 9, 2023

@maike93he I don't quite understand what is done in this PR. Where can I find the edisgo_documentation_examples.ipynb?

@maike93he
Copy link
Collaborator Author

@birgits sorry, the python notebook wasn't commited because it was untracked. The notebook - which contains examples from the documentation - is integrated in the test_examples.py file to automatically test the examples from the doc.

@birgits birgits removed request for birgits and khelfen March 2, 2023 08:15
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.

[FEATURE] Improve rtd documentation
2 participants