Documentation overhaul #462
Merged
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
|
For the worked example, here's the (zipped) Coquimbo notebook I've written. It's based of my working Lyon example and depends on the data within #461. I'm not sure if there is an automated way to convert this into the format required for the documentation. |
|
@djfrancesco We'll need to merge main/cherry-pick #447 if we want the documentation CI to build correctly. |
Format doc strings to RST. HTML generated docs look correct. Not sure how to set the class included in the TOC.
Jake-Moss
force-pushed
the
feature_PuT_assignment
branch
from
da75667 to
2b83466
Compare
Jake-Moss
merged commit 2b83466
into
AequilibraE:feature_PuT_assignment
31 of 32 checks passed
|
Mistakenly merged, will reopen as I have more doc changes to come |
djfrancesco
added a commit
that referenced
this pull request
Dec 2, 2023
Documentation for PuT (#462 fix)
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.
Format doc strings to RST. HTML generated docs look correct. Not sure how to set the class included in the TOC.
Small change made to the noise generation, if we are creating an RNG, we should use it.