WIP: Docs #49
Merged
WIP: Docs #49
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Important: Merge PR #47 first and then rebase this one |
CFGrote
requested review from
JunCEEE,
mads-bertelsen and
shervin86
and removed request for
JunCEEE and
mads-bertelsen
Merged
added 5 commits
May 3, 2022 22:56
* Renamed 'pointer' to 'reference' (there are no pointers in python) * Removed commented code * Removed logging since not used.
* Typo in authors list * Remove implementation of init_parameters(), it's an abstract class, so raise * NotImplementedError. * black reformatting.
* Expose all user facing classes in the main __init__. * Add summary table and toc entries to each class in the reference manual * Add pandoc to doc requirements * Fix mispelled module name in refman.rst
Adding material to Problem statement and insert headings according to issue #48
JunCEEE
reviewed
May 4, 2022
|
can we merge this asap please? |
added 2 commits
May 17, 2022 15:36
Add sphinx_autodoc_typehints as dependency for building docs.
Co-authored-by: Carsten Fortmann-Grote <[email protected]>
… instrument The output() now returns the data from the last calculator
shervin86
approved these changes
May 17, 2022
|
can we delete the |
|
Yes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds several improvements to the documentation. Mostly following PR #48 plus better structure in the Reference Manual