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.
test
¶
Run the unit tests.
docs
¶
Build the documentation for production.
Note
You can also build the documents directly, bypassing validations like linting and testing using Sphinx Makefile directly.
cd docs
make clean && make html
make latexpdf
answers
¶
Perform a quick build of the documentation and open it in your browser.
package
¶
Build the package for publishing.
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.