docs: basic API reference docs #128
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
…s the linter, which thinks it's the module docstring.
tonyandrewmeyer
added a commit
to tonyandrewmeyer/ops-scenario
that referenced
this pull request
Jul 9, 2024
* Bump required ops version to 2.12 to get CloudSpec/CloudCredential. * Bump version. * Add generation of API reference documentation. * Remove the jujulogline doc, which doesn't work correctly, and confuses the linter, which thinks it's the module docstring. * Handle ops caching the content.
This was referenced Jul 9, 2024
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.
This adds a
tox -e docscommand that will generate a local set of API reference documentation with Sphinx, modelled on the ops API reference docs (in turn based on the Canonical docs starter pack). There's also atox -e docs-depscommand to regenerate the requirements file for generating the docs.The docs are not pushed anywhere, but can be opened locally (from the
docs/_buildfolder that is generated). Most likely, once we have the installation story complete, they'll be found on ops.readthedocs.io. For now, this provides a way to compare the API inmainand the7.0branch (once this is also merged to there).The new files are all from the starter pack, with customisations only in
custom_conf.py.A few docstrings are added/adjusted, but in general it seems like it would be better to do that in the 7.0 branch to avoid double-work.