Autodoc confdefs #1772
Merged
Autodoc confdefs #1772
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
Contributor
vEpiphyte
commented
Jun 15, 2020
•
vEpiphyte
commented
- Part out devops guide into discrete portions
- Update autodoc to generate a enumerated list of configuration options for a Cell
- UPdate autodoc to be able to generate RST documents for stormservice configurations.
- Add configuration notes about the Cell.
- Add autodoc data to the docs for the Cortex, Axon, Cryotank and SyncMigrator
vEpiphyte
commented
Jun 15, 2020
| lines = [] | ||
| lines.append(desc) | ||
|
|
||
| extended_description = conf.get('extended_description') |
There was a problem hiding this comment.
This allows us to embed reform sphinx RST into confdefs
Codecov Report
@@ Coverage Diff @@
## master #1772 +/- ##
==========================================
- Coverage 96.14% 92.81% -3.33%
==========================================
Files 139 139
Lines 26331 26474 +143
==========================================
- Hits 25315 24571 -744
- Misses 1016 1903 +887
Continue to review full report at Codecov.
|
* update storm service docs * split out cell config docs * move cell config to its own file * Add unit tests for new autodoc functionality. Co-authored-by: epiphyte <[email protected]>
* Add autodocs support for generating rst from a stormservice definition Co-authored-by: redox <[email protected]>
Cisphyx
reviewed
Jun 16, 2020
Cisphyx
reviewed
Jun 16, 2020
Cisphyx
reviewed
Jun 16, 2020
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.