Skip to content

Commit

Permalink
Make some development documentation up-to-date (#3643)
Browse files Browse the repository at this point in the history
* Make some develoment documentation up-to-date

* regen docs
  • Loading branch information
gerardsn authored Jan 10, 2025
1 parent 2c55128 commit 7b78829
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 35 deletions.
24 changes: 9 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,6 @@ To enable ES256K (Koblitz) support, you need to build with the ``jwx_es256k`` ta
go build -tags jwx_es256k
Building for exotic environments
================================

You can build and run the Nuts node on more exotic environments, e.g. Raspberry Pis:

* 32-bit ARMv6 (Raspberry Pi Zero): ``env GOOS=linux GOARCH=arm GOARM=6 go build``

Running tests
*************

Expand Down Expand Up @@ -99,23 +92,24 @@ Protobuf + gRCP ``make gen-protobuf``
All ``make run-generators``
================ =======================

README
======
Documentation
=============

The readme is auto-generated from a template and uses the documentation to fill in the blanks.
The documentation is automatically build on readthedocs based on the config in ``.readthedocs.yaml``.
All files to be included can be generated using:

.. code-block:: shell
make gen-readme
make cli-docs
Documentation
=============
This regenerates files from code, and the ``README.rst`` file which requires python package ``rst-include`` (``pip install rst-include``).

The documentation can be build by running the following command from the ``/docs`` directory:
If needed, you can also build the documentation locally in ``/docs/_build`` using docker:

.. code-block:: shell
make html
docker build -t local/nuts-node-docs ./docs
docker run --rm -v ./docs:/docs local/nuts-node-docs
Configuration
^^^^^^^^^^^^^
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Nuts Node Documentation
# Nuts Node Documentation

Documentation gets compiled with a mixture of tooling into the `_build` directory.
Building the documentation is mostly done on readthedocs based on settings configured on `.readthedocs.yaml` in the project root.

Run `make docs` in the parent/base directory first.
To build the documentation locally, run `make cli-docs` in the parent directory first and then compile the rest in the `_build` directory using:

```shell
docker build -t nutsfoundation/nuts-node-docs .
docker run --rm -v $PWD:/docs nutsfoundation/nuts-node-docs
docker build -t nuts-node-docs .
docker run --rm -v $PWD:/docs nuts-node-docs
```
24 changes: 9 additions & 15 deletions docs/pages/development/1-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,6 @@ To enable ES256K (Koblitz) support, you need to build with the ``jwx_es256k`` ta
go build -tags jwx_es256k
Building for exotic environments
================================

You can build and run the Nuts node on more exotic environments, e.g. Raspberry Pis:

* 32-bit ARMv6 (Raspberry Pi Zero): ``env GOOS=linux GOARCH=arm GOARM=6 go build``

Running tests
*************

Expand Down Expand Up @@ -73,20 +66,21 @@ Protobuf + gRCP ``make gen-protobuf``
All ``make run-generators``
================ =======================

README
======
Documentation
=============

The readme is auto-generated from a template and uses the documentation to fill in the blanks.
The documentation is automatically build on readthedocs based on the config in ``.readthedocs.yaml``.
All files to be included can be generated using:

.. code-block:: shell
make gen-readme
make cli-docs
Documentation
=============
This regenerates files from code, and the ``README.rst`` file which requires python package ``rst-include`` (``pip install rst-include``).

The documentation can be build by running the following command from the ``/docs`` directory:
If needed, you can also build the documentation locally in ``/docs/_build`` using docker:

.. code-block:: shell
make html
docker build -t local/nuts-node-docs ./docs
docker run --rm -v ./docs:/docs local/nuts-node-docs

0 comments on commit 7b78829

Please sign in to comment.