Initial setup for RTD Integration #206
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
Set up documentation integration with RTD using sphinx-docs-starter-pack following the instruction: https://github.com/canonical/sphinx-docs-starter-pack#documentation-in-a-code-repository
|
@pmatulis I've updated the configuration as requested (I missed that section in README). May I ask for your review again? |
|
@agileshaw all good 🥇 |
aieri
reviewed
Jan 5, 2024
There was a problem hiding this comment.
Overall +1, just a couple of notes:
- since this is the initial setup and does not contain the actual documentation wouldn't it be better to merge into an integration branch and keep master clean?
- I know I asked to not exclude /docs/ from codespell, but now I have read that the documentation is already checked via aspell, so perhaps it's cleaner if we only rely on one spell checker
aieri
approved these changes
Jan 5, 2024
gabrielcocenza
pushed a commit
to gabrielcocenza/charmed-openstack-upgrader-1
that referenced
this pull request
Jan 11, 2024
* Initial setup for RTD Integration Set up documentation integration with RTD using sphinx-docs-starter-pack following the instruction described in [sphinx-docs-starter-pack](https://github.com/canonical/sphinx-docs-starter-pack) repository (notable references: section [documentation-in-a-code-repository](https://github.com/canonical/sphinx-docs-starter-pack?tab=readme-ov-file#documentation-in-a-code-repository) and [configure-the-documentation](https://github.com/canonical/sphinx-docs-starter-pack?tab=readme-ov-file#configure-the-documentation))
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.
Set up documentation integration with RTD using sphinx-docs-starter-pack following the instruction described in sphinx-docs-starter-pack repository (notable references: section documentation-in-a-code-repository and configure-the-documentation)