Move docs to readthedocs #899
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
Official docs is now hosted on the readthedocs. https://eventlet.readthedocs.io/en/latest/ Only branches or tags containing the previous readthedocs setup are able to been displayed. For now only the master branch contains the right setup. Historically, the docs was hosted on gh-pages. This previous setup only host the last built version. No parallel versions of the docs were possible. This new way of documenting eventlet allow us to parallelize versions. That will be better to reflect deprecations, removal, or additions. Now remain a bit of work: - make other maintainers readthedocs admin - transfer eventlet.net to readthedocs - disable gh-pages
4383
force-pushed
the
update-doc-links
branch
from
51ef50d
to
7088fb1
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #899 +/- ##
=====================================
- Coverage 56% 56% -1%
=====================================
Files 89 89
Lines 9717 9717
Branches 1810 1810
=====================================
- Hits 5458 5457 -1
- Misses 3884 3885 +1
Partials 375 375
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Worth merging it before releasing 0.35.0, as we could benefit from this patch to update pypi's docs links with the latest published version (0.35.0) |
itamarst
approved these changes
Jan 19, 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.
Official docs is now hosted on the readthedocs https://eventlet.readthedocs.io/en/latest/.
Only branches or tags containing the previous readthedocs setup are able to been displayed.
For now only the master branch contains the right setup.
Historically, the docs was hosted on gh-pages. This previous setup only host the last built version.
No parallel versions of the docs were possible.
This new way of documenting eventlet allow us to parallelize versions.
That will be better to reflect deprecations, removal, or additions.
Now remain a bit of work: