.. _make:
.. toctree::
:glob:
.. _using-the-makefile:
Using the `Makefile`
====================
This project includes a `Makefile `_
that you can use to perform common tasks such as running tests and building
documentation.
Targets
-------
This section contains a brief description of the targets defined in the
``Makefile``.
``clean``
^^^^^^^^^
Remove generated packages, documentation, temporary files, *etc*.
.. _make_lint:
``lint``
^^^^^^^^
Run `pylint `_ against the project files.
.. _make_test:
``test``
^^^^^^^^
Run the unit tests.
``quicktest``
^^^^^^^^^^^^^
Run the unit tests without performing pre-test validations (like
:ref:`linting `).
.. _make_docs:
``docs``
^^^^^^^^
Build the documentation for production.
.. note::
You can also build the documents directly, bypassing validations like
:ref:`linting ` and :ref:`testing ` using
`Sphinx Makefile `_
directly.
.. code-block:: bash
cd docs
make clean && make html
make latexpdf
.. _make_answers:
``answers``
^^^^^^^^^^^
Perform a quick build of the documentation and open it in your browser.
``package``
^^^^^^^^^^^
Build the package for publishing.
.. _make-publish:
``publish``
^^^^^^^^^^^
Publish the package to your repository.
``build``
^^^^^^^^^
Install the current project locally so that you may run the command-line application.
``venv``
^^^^^^^^
Create a virtual environment.
``install``
^^^^^^^^^^^
Install (or update) project dependencies.
``licenses``
^^^^^^^^^^^^
Generate a report of the projects dependencies and respective licenses.
.. note::
If project dependencies change, please update this documentation.