Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog documentation on readthedocs points to the wrong changelog #985

Open
tim-schilling opened this issue Dec 31, 2024 · 2 comments
Open

Comments

@tim-schilling
Copy link

The readthedocs change log page (https://django-tables2.readthedocs.io/en/latest/pages/upgrade-changelog.html) links to the docs/pages/changelog.md file but that doesn't exist. It's intended to point to https://github.com/jieter/django-tables2/blob/master/CHANGELOG.md

I'm guessing trying to link to a markdown file not in the docs folder will be problematic, so maybe that should be a link to github?

@jieter
Copy link
Owner

jieter commented Jan 2, 2025

Thanks for letting me know.

I'm pretty sure this used to work because of a symlink created in the documentation build process, we'll have to check why that doesn't work anymore.

# symlink CHANGELOG.md from repo root to the pages dir.
basedir = Path(__file__).parent.parent
filename = "CHANGELOG.md"
target = basedir / "docs" / "pages" / filename
if not target.is_symlink():
target.symlink_to(basedir / filename)

@tim-schilling
Copy link
Author

Ah gotcha!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants