From 26263211cfa6b2465cb137b18baa5287796207d5 Mon Sep 17 00:00:00 2001 From: Bernat Gabor Date: Mon, 25 Jun 2018 13:59:24 +0100 Subject: [PATCH] Unify changelog sections, shorten documentation --- CHANGELOG.rst | 16 ++++++++-------- pyproject.toml | 2 +- tox.ini | 3 +-- 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c310d3e58..ff34f2a06 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -91,8 +91,8 @@ Features ``platform.machine()``. (`#740 `_) -Documentation improvements -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Documentation +^^^^^^^^^^^^^ - Change favicon to the vector beach ball - by @hazalozturk (`#748 `_) @@ -118,8 +118,8 @@ Miscellaneous 2.9.1 (2017-09-29) ------------------ -Misc -^^^^ +Miscellaneous +^^^^^^^^^^^^^ - integrated new release process and fixed changelog rendering for pypi.org - by `@obestwalter `_. @@ -145,8 +145,8 @@ Bugfixes (`#571 `_) -Misc -^^^^ +Miscellaneous +^^^^^^^^^^^^^ - `#635 `_ inherit from correct exception - by `@obestwalter `_ @@ -158,8 +158,8 @@ Misc by `@obestwalter `_. -Improved Documentation -^^^^^^^^^^^^^^^^^^^^^^ +Documentation +^^^^^^^^^^^^^ - add `towncrier `_ to allow adding changelog entries with the pull requests without generating merge conflicts; diff --git a/pyproject.toml b/pyproject.toml index cd6bf9b5f..deec89010 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,7 +39,7 @@ requires = [ [[tool.towncrier.type]] directory = "doc" - name = "Documentation improvements" + name = "Documentation" showcontent = true [[tool.towncrier.type]] diff --git a/tox.ini b/tox.ini index 0a43289a5..5ec621180 100644 --- a/tox.ini +++ b/tox.ini @@ -22,12 +22,11 @@ commands = pytest {posargs:--cov="{envsitepackagesdir}/tox" --cov-config="{toxin [testenv:docs] description = invoke sphinx-build to build the HTML docs and check that all links are valid -passenv = * basepython = python3.6 extras = docs changedir = {toxinidir} commands = sphinx-build -d "{toxworkdir}/docs_doctree" doc "{toxworkdir}/docs_out" --color -W -bhtml {posargs} - python -m webbrowser -t "{toxworkdir}/docs_out/index.html" + python -c 'print("documentation available under file://{toxworkdir}/docs_out/index.html")' [testenv:fix-lint] description = format the code base to adhere to our styles, and complain about what we cannot do automatically