Add changelog to docs

[rgaudin]

Noticed the docs doesn't include the changelog which would be very handy and is common in similar projects (instead of root).

[kelson42]

I don't understand this feature request. Why the changelog should be in docs?

[rgaudin]

For the same reason we include it in the sources. It's valuable piece of information that is tied with a specific release.
Ideally, library users never have to come to the repository/github. Just using the online doc should be enough.
Changelog contains information that's not reflected in the docs: added/dropped support for platforms, release-tied changes that would require a lot of browsing from the docs's version switcher to obtain, etc.

I opened the ticket when responding to openzim/wikihow#166. I wanted to know when we introduced Windows support but it was not avail in the docs.

It's quite common for docs to provide this information. I'm actually surprised it raised a question.

[kelson42]

@rgaudin OK, so you mean a link to the CHANGELOG?

[rgaudin]

A link would be enough indeed ; or a doc page containing it (docs are generated anyway)

[kelson42]

@rgaudin All good, just not in favour of a duplicate (obviously) and pretty concerned by migrating the changelog outside the root.

[rgaudin]

not in favour of a duplicate (obviously)

Obviously

pretty concerned by migrating the changelog outside the root.

I guess #228 lead you to think this way. That's not wanted at all (nor required).

[aaryansinhaa]

Is this issue still open?

[aaryansinhaa]

Hey @rgaudin and @kelson42 ,

Do you guys want a simple link to the CHANGELOG.md or want to have it embedded in the readthedocs?

If it's a simple link, we can simply add

nav:
  - Home: index.md
  - API Reference: api_reference/
  - Changelog: 'https://github.com/openzim/python-libzim/blob/main/CHANGELOG.md'
  - License: license.md

Other wise we can add an extension, ref: mkdocs discussion.

Either way, I feel like I can solve this issue, should I make a PR to close this issue, or wait to have this issue assigned to me?

[rgaudin]

Ideally included ; please submit a PR