Fix ReadTheDocs by adding configuration file #693
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
The documentation is failing to upload to ReadTheDocs [because it doesn't build](https://app.readthedocs.org/projects/hazelcast/builds/25183105/): > Config file not found at default path The required .readthedocs.yaml configuration file was not found at repository's root. This means that the [latest available version](https://hazelcast.readthedocs.io/en/latest/) listed is `v5.3.0`, `v5.4.0` is missing:  I've created a simple configuration [based on their documentation](https://docs.readthedocs.io/en/stable/config-file/index.html) to address this. I've [built this branch on ReadTheDocs](https://app.readthedocs.org/projects/hazelcast/builds/25186169/) to create a public-but-unlisted site [here](https://hazelcast.readthedocs.io/en/fix-readthedocs-3/). Discovered by [PR feedback](hazelcast/rel-scripts#22 (comment)).
srknzl
approved these changes
Aug 2, 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.
The documentation is failing to upload to ReadTheDocs because it doesn't build:
This means that the latest available version listed is
v5.3.0,v5.4.0is missing:I've created a simple configuration based on their documentation to address this.
I've built this on ReadTheDocs to create a public-but-unlisted site here.
Discovered by PR feedback.