Skip to content

Commit

Permalink
Update NEWS, README for Hieroglyph 2.0
Browse files Browse the repository at this point in the history
This is a major version bump because we're dropping support for:

* Python 2
* Sphinx 1.x
  • Loading branch information
nyergler committed Jun 27, 2020
1 parent e80084e commit e31dd7c
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 13 deletions.
9 changes: 5 additions & 4 deletions NEWS.txt
@@ -1,13 +1,14 @@
News
====

1.1
2.0
---

*Release date: _unreleased_*
*Release date: 27 June 2020*

* Drop support for Sphinx < 1.7
* Fix compatibility with Sphinx 2
* Drop support for Python 2.x
* Drop support for Sphinx < 2.0
* Fix compatibility with Sphinx 2 and 3
* Enabled parallel reading of source files

1.0
Expand Down
28 changes: 27 additions & 1 deletion README.rst
Expand Up @@ -24,7 +24,7 @@ contain new features::

$ pip install git+https://github.com/nyergler/hieroglyph#egg=hieroglyph

Hieroglyph supports Sphinx 1.7 and later, and Python 2.7 and 3.6.
Hieroglyph supports Sphinx 2.4 and later, and Python 3.7 and later.

Using Hieroglyph
================
Expand Down Expand Up @@ -64,6 +64,29 @@ also available.
.. _`hieroglyph-users`: http://groups.google.com/d/forum/hieroglyph-users
.. _`Gmane archive`: http://dir.gmane.org/gmane.comp.python.hieroglyph.user

Developing
==========

Making a Release
----------------

Hieroglyph uses `Versioneer`_ for managing verison numbers. Versioneer is
able to derive a reasonable version number using git tags as the source of
truth.

To create a release, do the following:

* Update the change log (`NEWS.txt`_)
* Tag the release commit as `hieroglyph-x.y.z`
* Build the distributions using `setup.py`::

$ python setup.py sdist bdist_wheel

* Push the changes to Github & upload to PyPI using `Twine`_::

$ git push origin head
$ twine upload dist/<built filenames>

License
=======

Expand All @@ -78,3 +101,6 @@ License.
.. _`HTML 5 Slides`: http://code.google.com/p/html5slides/
.. _`io-2012-slides`: https://code.google.com/p/io-2012-slides/
.. _`Read the documentation`: http://docs.hieroglyph.io/
.. _`Versioneer`: https://github.com/warner/python-versioneer
.. _`Twine`: https://twine.readthedocs.io/en/latest/
.. _`NEWS.txt`: ./NEWS.txt
2 changes: 1 addition & 1 deletion setup.cfg
Expand Up @@ -4,7 +4,7 @@
universal = 1

[bdist_rpm]
requires = python-sphinx >= 1.4 python-six
requires = python-sphinx >= 2.0

[versioneer]
vcs = git
Expand Down
1 change: 0 additions & 1 deletion setup.py
Expand Up @@ -25,7 +25,6 @@
'License :: OSI Approved :: BSD License',
'Topic :: Documentation',
'Topic :: Text Processing',
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 3",
],
keywords='',
Expand Down
10 changes: 4 additions & 6 deletions tox.ini
@@ -1,16 +1,14 @@
[tox]
envlist = {py27,py37}-sphinx{17,18},py37-sphinx{20,21,tip}
envlist = {py37,py38}-sphinx{24,30,tip}

[testenv]
basepython =
py27: python2.7
py37: python3.7
py38: python3.8
deps =
pytest
sphinx17: Sphinx~=1.7.0
sphinx18: Sphinx~=1.8.0
sphinx20: Sphinx~=2.0.0
sphinx21: Sphinx~=2.1.0
sphinx24: Sphinx~=2.4.0
sphinx30: Sphinx~=3.0.0
sphinxtip: git+https://github.com/sphinx-doc/sphinx.git#egg=Sphinx
whitelist_externals=
rake
Expand Down

0 comments on commit e31dd7c

Please sign in to comment.