docs/pages/development/consent-logic.rst
.. _nuts-consent-logic-development:
Nuts Consent Logic development
#####################
.. marker-for-readme
This module is written in Go and should be part of nuts-go as an engine.
Running tests
*************
Tests can be run by executing
.. code-block:: shell
go test ./...
Generating code
***************
.. code-block:: shell
oapi-codegen -generate server,types -package api docs/_static/nuts-consent-logic.yaml > api/generated.go
Building
********
This project is part of https://github.com/nuts-foundation/nuts-go. If you do however would like a binary, just use ``go build``.
README
******
The readme is auto-generated from a template and uses the documentation to fill in the blanks.
.. code-block:: shell
./generate_readme.sh
This script uses ``rst_include`` which is installed as part of the dependencies for generating the documentation.
Documentation
*************
To generate the documentation, you'll need python3, sphinx and a bunch of other stuff. See :ref:`nuts-documentation-development-documentation`
The documentation can be build by running
.. code-block:: shell
/docs $ make html
The resulting html will be available from ``docs/_build/html/index.html``