Metadata-Version: 2.0
Name: rst2sh5
Version: 0.0.0
Summary: Docutils writer outputting semantic HTML5
Home-page: https://github.com/sinoroc/rst2sh5
Author: sinoroc
Author-email: sinoroc.code+python@gmail.com
License: Apache-2.0
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Requires-Dist: beautifulsoup4
Requires-Dist: docutils
Requires-Dist: html5lib
Requires-Dist: setuptools
Provides-Extra: package
Requires-Dist: pex; extra == 'package'
Requires-Dist: twine; extra == 'package'
Requires-Dist: wheel; extra == 'package'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-pep8; extra == 'test'
Requires-Dist: pytest-pylint; extra == 'test'
Requires-Dist: readme-renderer; extra == 'test'

..


.. contents::

.. sectnum::


Hacking
=======

This project makes extensive use of `tox`_, `pytest`_, and `GNU Make`_.


Development environment
-----------------------

Use following command to create a Python virtual environment with all
necessary dependencies::

    tox --recreate -e develop

This creates a Python virtual environment in the ``.tox/develop`` directory. It
can be activated with the following command::

    . .tox/develop/bin/activate


Run test suite
--------------

In a Python virtual environment run the following command::

    make review

Outside of a Python virtual environment run the following command::

    tox --recreate


Build and package
-----------------

In a Python virtual environment run the following command::

    make package

Outside of a Python virtual environment run the following command::

    tox --recreate -e package


.. Links

.. _`GNU Make`: https://www.gnu.org/software/make/
.. _`pytest`: http://pytest.org/
.. _`tox`: https://tox.readthedocs.io/


.. EOF


