From 7b788299ab45abda7a9927eae70dea9340c874df Mon Sep 17 00:00:00 2001 From: Gerard Snaauw <33763579+gerardsn@users.noreply.github.com> Date: Fri, 10 Jan 2025 13:27:11 +0100 Subject: [PATCH] Make some development documentation up-to-date (#3643) * Make some develoment documentation up-to-date * regen docs --- README.rst | 24 +++++++++--------------- docs/README.md | 10 +++++----- docs/pages/development/1-development.rst | 24 +++++++++--------------- 3 files changed, 23 insertions(+), 35 deletions(-) diff --git a/README.rst b/README.rst index d1a6815068..a5d8817063 100644 --- a/README.rst +++ b/README.rst @@ -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 ************* @@ -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 ^^^^^^^^^^^^^ diff --git a/docs/README.md b/docs/README.md index 4240082c0b..4de6b16962 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 ``` diff --git a/docs/pages/development/1-development.rst b/docs/pages/development/1-development.rst index 3ee4fa4294..cd6cd5530e 100644 --- a/docs/pages/development/1-development.rst +++ b/docs/pages/development/1-development.rst @@ -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 ************* @@ -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 \ No newline at end of file