Add Python API reference docs #1358
Merged
+75
−66
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
"keypair" should really be "key pair" in docstrings and such but is written as keyPair in Nix expressions. Codespell says "IAM" should be "I am" which is incorrect (IAM is an AWS thing). Codespell says "hda" should be "had" which is wrong for obvious reasons :)
Reference docs surfaces a lot of issues with circular import. Let's not block reference docs on fixing circular imports, this is another issue entirely.
adisbladis
force-pushed
the
reference-docs
branch
from
ef2c411
to
909c18e
Compare
nlewo
reviewed
Jun 9, 2020
| @@ -3,6 +3,6 @@ | |||
|
|
|||
| set -eux | |||
|
|
|||
| git ls-files | xargs codespell | |||
| git ls-files | xargs codespell -L keypair,iam,hda | |||
There was a problem hiding this comment.
Is keypair keyword still needed here since there are fixed?
There was a problem hiding this comment.
Yes, the nix expressions still says keyPair.
| sphinx-build -M clean doc/ doc/_build | ||
| sphinx-build -nW doc/ doc/_build | ||
| sphinx-build -n doc/ doc/_build |
There was a problem hiding this comment.
Yes :/
We have circular imports guarded by typing.TYPE_CHECKING. That's not a problem for Mypy but it is a problem for Sphinx.
nlewo
approved these changes
Jun 9, 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.
No description provided.