Modernize doc generation #880
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #880 +/- ##
=====================================
Coverage 55% 55%
=====================================
Files 90 90
Lines 9855 9855
Branches 1827 1827
=====================================
Hits 5437 5437
Misses 4050 4050
Partials 368 368
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
4383
force-pushed
the
refactor-docs-generating
branch
9 times, most recently
from
b1d18fc
to
e5b90d1
Compare
| @@ -0,0 +1,32 @@ | |||
| # .readthedocs.yaml | |||
There was a problem hiding this comment.
We should link to the new URL for docs in the README.
There was a problem hiding this comment.
I'll do another patch to update the links (in the pyproject.toml file too) once the docs will be online on readthedocs.
| @@ -0,0 +1,32 @@ | |||
| # .readthedocs.yaml | |||
| # Read the Docs configuration file | |||
There was a problem hiding this comment.
Do we have a way to update the old docs to point to the new URL? Otherwise Google will point people at old docs and they won't know new ones exist.
There was a problem hiding this comment.
readthedocs allow custom domains. We could simply redirect the eventlet.orgeventlet.net domain to the new readthedocs hosted instance. Every users would be automatically redirected.
Also, if necessary, we could publish an empty html index on the github page containing the following javascript instruction to redirect to the new docs hosted on readthedocs:
window.location.href = ‘https://eventlet.readthedocs.io/’;
The docs is not yet online on readthedocs as the readthedocs config file is mandatory to allow building. The snake bites its tail. The url will be https://eventlet.readthedocs.io/ and http://eventlet.rtfd.io/ |
Fixed by 131651a |
- Move files into doc/source - Create a new testenv related to docs. - Manage docs requirements into a dedicated file - Remove obsolete makefile and build artifacts
Also: - fix path in the existing script - adapt gitignore rule to track github actions
4383
force-pushed
the
refactor-docs-generating
branch
from
e5b90d1
to
5442a10
Compare
Related to #879
Run docs generation on pull requests, too many docstring errors have been accepted, leading us to broken docs generation.
Fix a couple of error related to docs.
Setup the eventlet repo to host the doc on readthedocs rather than on github pages. Docs are automatically generated each time we will push changes (commits, tags), no needs to run doc generation manually and to push it to github-pages.