An open API service indexing awesome lists of open source software.

https://github.com/sinoroc/rst2sh5

Docutils writer outputting semantic HTML5
https://github.com/sinoroc/rst2sh5

docutils html5 restructuredtext semantic-html

Last synced: 8 months ago
JSON representation

Docutils writer outputting semantic HTML5

Awesome Lists containing this project

README

          

..

.. 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