Revise and update source code documentation and build with sphinx #369
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
Revise/shorten/consolidate/update main API function-, class- and method- docstrings: - verifylib.in_toto_verify - runlib.in_toto_run - runlib.in_toto_record_start - runlib.in_toto_record_stop - models.metadata.Metablock - models.link.Link - models.layout.Layout - models.layout.Step - models.layout.Inspection - models.common.Signable (only parts relevant for read the docs) - models.common.ValidationMixin (only relevant parts) Changes custom Secure Systems Lab docstring format to Google format, which is machine- (sphinx) and human-readable. (Choosing Google over NumPy because it requires less vertical space, see https://sphinxcontrib-napoleon.readthedocs.io/en/latest/#google-vs-numpy) Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
+ revise and update Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
- Switch from alabaster to sphinx_rtd_theme - Add napoleon sphinx extension to parse Google-style docstrings - Add todo sphinx extension (for utils docs) - Comment out currently unused html_static_path that triggered a warning Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Fix issues that occurred after swithing to sphinx-rtd-theme. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
+ some minor updates on the docs landing page, like pointers to other in-toto resources. Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
This was referenced Jun 17, 2020
SantiagoTorres
approved these changes
Jun 23, 2020
This was referenced Jun 24, 2020
Merged
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.
Fixes issue #:
Mostly fixes #284
Description of the changes being introduced by the pull request:
See commit messages for details about the changes and https://in-toto-lukpueh.readthedocs.io/en/latest/ for the changes in action.
Please verify and check that the pull request fulfills the following
requirements: