doc: Repair changelog link

[skieffer]

Currently, the link to the changelog found in the Eventlet docs at https://eventlet.readthedocs.io/en/latest/index.html#changelog links to the Python changelog, at https://docs.python.org/3/whatsnew/changelog.html#changelog.

This PR changes it to point to https://github.com/eventlet/eventlet/blob/master/NEWS

Other possibilities

I noticed there's a reference to a changelog.html here:

eventlet/doc/source/real_index.html

Line 151 in c22b896

<li><a class="reference external" href="doc/changelog.html">Changelog</a></li>

so maybe there was some intention to generate a true changelog page, belonging to the docs? Don't know.

[4383]

Good catch, thanks.

I wonder if rather than pointing out an url, if it would be possible to refer to a file, I know this possible but I always forget the syntax to use... a kink of thing like this:

:ref:`../../NEWS`

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56%. Comparing base (c22b896) to head (36be0da).

Additional details and impacted files

@@          Coverage Diff          @@
##           master   #958   +/-   ##
=====================================
  Coverage      56%    56%           
=====================================
  Files          89     89           
  Lines        9767   9767           
  Branches     1819   1819           
=====================================
+ Hits         5477   5479    +2     
+ Misses       3920   3919    -1     
+ Partials      370    369    -1     

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

[skieffer]

I wonder if rather than pointing out an url, if it would be possible to refer to a file

There's

:doc:`../../some/other/file`

for referring to other pages within the Sphinx project, but the NEWS file lives up outside of doc/source, so as far as I know that wouldn't work.

Unless your build script involves a step that copies the NEWS file into doc/source before building, it seems the URL might be the easiest solution.

Also: Linking directly to the github URL means people get to see the most up to date version.

[4383]

I wonder if rather than pointing out an url, if it would be possible to refer to a file

There's

:doc:`../../some/other/file`

for referring to other pages within the Sphinx project, but the NEWS file lives up outside of doc/source, so as far as I know that wouldn't work.

Indeed, I just tested it locally and it finished with a display of the passed url...
Let's drop that idea.

Unless your build script involves a step that copies the NEWS file into doc/source before building, it seems the URL might be the easiest solution.

No I don't think we want to spend more time on this topic, using the url will do the job.

Also: Linking directly to the github URL means people get to see the most up to date version.

Indeed, thanks.

[4383]

Thank you for your contribution. Much appreciated

[skieffer]

Thanks for the review, and for your work on this project!