-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make some development documentation up-to-date (#3643)
* Make some develoment documentation up-to-date * regen docs
- Loading branch information
Showing
3 changed files
with
23 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters