Skip to content

Commit

Permalink
Unify changelog sections, shorten documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gaborbernat committed Jun 25, 2018
1 parent 6af88af commit 2626321
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
16 changes: 8 additions & 8 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ Features
``platform.machine()``. (`#740 <https://github.com/tox-dev/tox/issues/740>`_)


Documentation improvements
^^^^^^^^^^^^^^^^^^^^^^^^^^
Documentation
^^^^^^^^^^^^^

- Change favicon to the vector beach ball - by @hazalozturk
(`#748 <https://github.com/tox-dev/tox/issues/748>`_)
Expand All @@ -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 <https://github.com/obestwalter>`_.
Expand All @@ -145,8 +145,8 @@ Bugfixes
(`#571 <https://github.com/tox-dev/tox/issues/571>`_)


Misc
^^^^
Miscellaneous
^^^^^^^^^^^^^

- `#635 <https://github.com/tox-dev/tox/issues/635>`_ inherit from correct exception -
by `@obestwalter <https://github.com/obestwalter>`_
Expand All @@ -158,8 +158,8 @@ Misc
by `@obestwalter <https://github.com/obestwalter>`_.


Improved Documentation
^^^^^^^^^^^^^^^^^^^^^^
Documentation
^^^^^^^^^^^^^

- add `towncrier <https://github.com/hawkowl/towncrier>`_ to allow adding
changelog entries with the pull requests without generating merge conflicts;
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ requires = [

[[tool.towncrier.type]]
directory = "doc"
name = "Documentation improvements"
name = "Documentation"
showcontent = true

[[tool.towncrier.type]]
Expand Down
3 changes: 1 addition & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2626321

Please sign in to comment.