Skip to content

Move docs to readthedocs#899

Merged
4383 merged 2 commits intoeventlet:masterfrom
4383:update-doc-links
Jan 22, 2024
Merged

Move docs to readthedocs#899
4383 merged 2 commits intoeventlet:masterfrom
4383:update-doc-links

Conversation

@4383
Copy link
Copy Markdown
Member

@4383 4383 commented Jan 18, 2024

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

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 4383 force-pushed the update-doc-links branch from 51ef50d to 7088fb1 Compare January 18, 2024 14:44
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (387ca4b) 56% compared to head (a1660b1) 56%.

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           
Flag Coverage Δ
ipv6 23% <ø> (ø)
py310asyncio 53% <ø> (+<1%) ⬆️
py310epolls 53% <ø> (ø)
py310poll 53% <ø> (+<1%) ⬆️
py310selects 53% <ø> (+<1%) ⬆️
py311asyncio 53% <ø> (+<1%) ⬆️
py311epolls 53% <ø> (+<1%) ⬆️
py312asyncio 50% <ø> (-1%) ⬇️
py312epolls 51% <ø> (+<1%) ⬆️
py37asyncio 50% <ø> (ø)
py37epolls 51% <ø> (-1%) ⬇️
py38asyncio 51% <ø> (+<1%) ⬆️
py38epolls 53% <ø> (+<1%) ⬆️
py38openssl 52% <ø> (+<1%) ⬆️
py38poll 53% <ø> (-1%) ⬇️
py38selects 53% <ø> (+<1%) ⬆️
py39asyncio 51% <ø> (ø)
py39dnspython1 51% <ø> (+<1%) ⬆️
py39epolls 53% <ø> (+<1%) ⬆️
py39poll 53% <ø> (ø)
py39selects 53% <ø> (+<1%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@4383
Copy link
Copy Markdown
Member Author

4383 commented Jan 18, 2024

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)

#897

@4383 4383 added the doc label Jan 18, 2024
@4383 4383 merged commit 4f0a90b into eventlet:master Jan 22, 2024
@4383 4383 mentioned this pull request Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants