DOC: Build datastructure documentation #431
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
|
Seems to work OK, needs some tweaks to make it less noisy imo.
|
perolavsvendsen
approved these changes
Jan 26, 2024
There was a problem hiding this comment.
I think this is a good start. It is producing documentation from the code. We need to work on the readability of this, but having the documentation built will also make it easier to restructure for readability.
It is an open question to me if we should work further on this now, or merge this - then do incremental changes (perhaps make a plan for that part as well before leaping into it) but I am leaning towards merging it.
@jcrivenaes opinions?
janbjorge
changed the title
janbjorge
commented
Jan 26, 2024
| @@ -0,0 +1,32 @@ | |||
| # Tool for building the datastructure.rst file. | |||
There was a problem hiding this comment.
Hopefully we can find a way round using this script, but for now i have not found a way.
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.
Addresses #423