Skip to content
This repository was archived by the owner on Mar 13, 2026. It is now read-only.

docs: add markdown version of changelog#372

Merged
tswast merged 3 commits intogoogleapis:masterfrom
tswast:release-v0.16.0
Aug 19, 2021
Merged

docs: add markdown version of changelog#372
tswast merged 3 commits intogoogleapis:masterfrom
tswast:release-v0.16.0

Conversation

@tswast
Copy link
Copy Markdown
Contributor

@tswast tswast commented Jul 16, 2021 •
edited
Loading

Changelog converted with

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)

with open("docs/source/changelog.rst", "w", encoding="utf-8") as f:
    f.write(re.sub(c, r"`#\1 <https://github.com/googleapis/python-bigquery-pandas/issues/\1>`_", text))

and

pandoc --from=rst --to=gfm docs/source/changelog.rst -o CHANGELOG.md

Towards #353 and #367

@google-cla google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Jul 16, 2021
@tswast tswast marked this pull request as draft July 16, 2021 22:08
@tswast tswast added do not merge Indicates a pull request not ready for merge, due to either quality or timing. and removed autorelease: pending labels Jul 16, 2021
@product-auto-label product-auto-label Bot added the api: bigquery Issues related to the googleapis/python-bigquery-pandas API. label Jul 17, 2021
@tswast
docs: add markdown version of changelog
6f8d2a5 
TODO: make changelog page a symlink and render markdown in sphinx
@tswast tswast changed the title chore: Release v0.16.0 docs: add markdown version of changelog Aug 18, 2021
@tswast tswast removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Aug 18, 2021
@tswast tswast marked this pull request as ready for review August 18, 2021 19:54
@tswast tswast requested a review from a team August 18, 2021 19:54
@tswast
Copy link
Copy Markdown
Contributor Author

tswast commented Aug 18, 2021

Docs build locally:

(dev-3.9) ➜  python-bigquery-pandas git:(release-v0.16.0) nox -s docs
nox > Running session docs
nox > Creating virtual environment (virtualenv) using python3.8 in .nox/docs
nox > python -m pip install -r docs/requirements-docs.txt
nox > python -m pip install -e .
nox > sphinx-build -W -T -N -b html -d docs/source/_build/doctrees/ docs/source/ docs/source/_build/html/
Running Sphinx v4.1.2
making output directory... done
[autosummary] generating autosummary for: api.rst, changelog.md, contributing.rst, howto/authentication.rst, index.rst, install.rst, intro.rst, privacy.rst, reading.rst, writing.rst
loading intersphinx inventory from https://docs.python.org/objects.inv...
loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv...
loading intersphinx inventory from https://pydata-google-auth.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory from https://google-auth.readthedocs.io/en/latest/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 10 source files that are out of date
updating environment: [new config] 10 added, 0 changed, 0 removed
reading sources... [ 10%] api
reading sources... [ 20%] changelog
/Users/swast/src/python-bigquery-pandas/.nox/docs/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
  warn("Container node skipped: type={0}".format(mdnode.t))
reading sources... [ 30%] contributing
reading sources... [ 40%] howto/authentication
reading sources... [ 50%] index
reading sources... [ 60%] install
reading sources... [ 70%] intro
reading sources... [ 80%] privacy
reading sources... [ 90%] reading
reading sources... [100%] writing

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 10%] api
writing output... [ 20%] changelog
writing output... [ 30%] contributing
writing output... [ 40%] howto/authentication
writing output... [ 50%] index
writing output... [ 60%] install
writing output... [ 70%] intro
writing output... [ 80%] privacy
writing output... [ 90%] reading
writing output... [100%] writing

generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in docs/source/_build/html.
nox > Session docs was successful.

jimfulton
jimfulton reviewed Aug 18, 2021
View reviewed changes
Copy link
Copy Markdown

@jimfulton jimfulton left a 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.

Comment thread convert_changelog.py Outdated
Comment on lines +1 to +9
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))
Copy link
Copy Markdown

@jimfulton jimfulton Aug 18, 2021

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?

Copy link
Copy Markdown
Contributor Author

@tswast tswast Aug 18, 2021

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)

@tswast tswast requested a review from jimfulton August 18, 2021 22:08
jimfulton
jimfulton approved these changes Aug 19, 2021
View reviewed changes
Copy link
Copy Markdown

@jimfulton jimfulton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modulo automation

@tswast tswast merged commit 2f82070 into googleapis:master Aug 19, 2021
@tswast tswast deleted the release-v0.16.0 branch August 19, 2021 13:32
@tseaver tseaver mentioned this pull request Aug 19, 2021
Closed
13 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@jimfulton jimfulton jimfulton approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

api: bigquery Issues related to the googleapis/python-bigquery-pandas API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tswast @jimfulton