Docs: Improved doc generation #315
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
heueristik
commented
Mar 1, 2023
heueristik
commented
Mar 1, 2023
Closed
heueristik
changed the title
mathewmeconry
approved these changes
Mar 2, 2023
novaknole
approved these changes
Mar 2, 2023
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.
Description
We currently cannot update to a newersolidity-docgenversion (>0.6.0-beta.19) because of an issue in #311 (that I described here: OpenZeppelin/solidity-docgen#436)Besides improving the structure of the auto-generated docs, this PR introduces workarounds to fix the repeated generation of docs (known from OpenZeppelin/solidity-docgen#388).
The issue mentioned previously got fixed in OpenZeppelin/solidity-docgen#436 with
0.6.0-beta.35. This PR updatessolidity-docgenand improves the documentation structure.Task: APP-1954
Type of change