Create .readthedocs.yaml file #2268
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
Add readthedocs YAML file as required by RTD. Signed-off-by: Stephen Curran <[email protected]>
Adding sphinx option Signed-off-by: Stephen Curran <[email protected]>
|
Kudos, SonarCloud Quality Gate passed!
|
|
The added file looks good. Do we care that there are broken links in the generated docs (broken links exist in current, so nothing to do with this PR - ex. the protocols link in "Developers that are interested in what DIDComm protocols are supported in ACA-Py should take a look at the protocols package."). |
usingtechnology
approved these changes
Jun 15, 2023
|
No — for this issue we don’t care about the broken links. Something we should address separately, but not in this issue. |
|
Didn't think so, just wanted to check. |
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.
Add readthedocs YAML file as required by RTD. Per this blog post, this file is now required for publishing the type of documentation we generate to the RTD sites. For those not aware, here is the link to the RTD site for ACA-Py -- https://aries-cloud-agent-python.readthedocs.io
Here is the link to the version of the docs generated from this branch with this new file: https://aries-cloud-agent-python.readthedocs.io/en/swcurran-add-rtd/. LGTM!