adding start of docs #9
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
we will eventually want complete docstrings, but I want to find a nice way to do this first. I always use sphinx and I would like to render something directly into the markdown site Signed-off-by: vsoch <vsoch@users.noreply.github.com>
vsoch
added a commit
that referenced
this pull request
May 20, 2022
* adding start of docs we will eventually want complete docstrings, but I want to find a nice way to do this first. I always use sphinx and I would like to render something directly into the markdown site Signed-off-by: vsoch <vsoch@users.noreply.github.com> * isort Signed-off-by: vsoch <vsoch@users.noreply.github.com> Co-authored-by: vsoch <vsoch@users.noreply.github.com>
vsoch
added a commit
that referenced
this pull request
May 20, 2022
* adding start of docs we will eventually want complete docstrings, but I want to find a nice way to do this first. I always use sphinx and I would like to render something directly into the markdown site Signed-off-by: vsoch <vsoch@users.noreply.github.com> * isort Signed-off-by: vsoch <vsoch@users.noreply.github.com> Co-authored-by: vsoch <vsoch@users.noreply.github.com> Signed-off-by: vsoch <vsoch@users.noreply.github.com>
vsoch
added a commit
that referenced
this pull request
May 25, 2022
* update of oras-py design to have fully working pull/push to an OCI registry * adding authenticated views, docstrings, and typing * testing if we can run docker registry as service during action * adding basic tests for registry without auth * adding remainder of testing, also isort, mypy, black, pyflakes for linting! * adding docker build for oras-py (#7) * adding directory push and schemas for manifests/layer * adding start of docs (#9) * adding review tweaks and additional requests for custom client * refactoring docs to use pretty sphinx + material theme * updating docstrings format to render in sphinx * ensuring we have all documentation dependencies * we will want to preserve git history for pages to build and push successfully Signed-off-by: vsoch <vsoch@users.noreply.github.com>
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.
we will eventually want complete docstrings, but I want to find a nice way to do this
first. I always use sphinx and I would like to render something directly into the markdown site
Signed-off-by: vsoch vsoch@users.noreply.github.com