coder guide
=============
-.. Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>.
- Permission to use, copy, modify, and distribute this software is
- granted under terms provided in the LICENSE file distributed with
- this software.
+.. Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
+ modify, and distribute this software is granted under terms
+ provided in the LICENSE file distributed with this software.
This guide attempts to embody a rudimentary set of rules for developer
submissions of source code and documentation targeted for inclusion
A :file:`ChangeLog` is generated automatically from repository
commit logs, and is included automatically in all sdist_ tarballs. It
-can be regenerated easily by running :command:`tox -e venv python
-setup.py sdist` from the top level directory of the Git repository in
-a working `developer environment`_.
+can be regenerated easily by running :command:`tox -e dist` from the
+top level directory of the Git repository in a working `developer
+environment`_.
.. _Git: https://git-scm.com/
.. _sdist: https://packaging.python.org/glossary
Linux), a modern Python 3 interpreter (any of the minor revisions
mentioned in the ``metadata.classifier`` section of
:file:`setup.cfg`) and a recent release of the tox_ utility (at least
-the ``tox.minversion`` mentioned in :file:`tox.ini`).
+the ``tox.minversion`` mentioned in :file:`tox.ini`). The tox-venv_
+plug-in for tox is also recommended.
.. _tox: https://tox.readthedocs.io/
+.. _tox-venv: https://pypi.org/project/tox-venv/
application program interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-API documentation is maintained within docstrings in the mudpy source
-code.
+The :doc:`api` API documentation is maintained within docstrings in
+the mudpy source code.
regression testing
~~~~~~~~~~~~~~~~~~