-
Notifications
You must be signed in to change notification settings - Fork 125
docs: add markdown version of changelog #372
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
Conversation
TODO: make changelog page a symlink and render markdown in sphinx
be06855
to
6f8d2a5
Compare
Docs build locally:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't speak to the automation that this is supposed to interoperate with, but otherwise, this looks reasonable to me.
convert_changelog.py
Outdated
import re | ||
|
||
|
||
with open("docs/source/changelog.rst") as f: | ||
text = f.read() | ||
|
||
# :issue:`312` -> https://github.com/googleapis/python-bigquery-pandas/issues/312 | ||
c = re.compile(r":issue:`([0-9]+)`", flags=re.MULTILINE) | ||
print(re.sub(c, r"[#\1](https://github.com/googleapis/python-bigquery-pandas/issues/\1)", text)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this checked in? Isn't it a one-time script?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, good catch. Yeah, just a one-time script. Not even the final version I used (which is in the PR description)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Modulo automation
Changelog converted with
and
Towards #353 and #367