diff --git a/README.md b/README.md index 29a7ebdb1691bd713bbfc0afd62407ee772b7f2b..2056188cc7ff88eb1e9cb0a4cbfe05a65130af32 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ The GÉANT interpretation of [`orchestrator-core`](https://github.com/workfloworchestrator/orchestrator-core). ## Documentation -You can build the documentation locally using [build_docs.sh](build_docs.sh). +You can build the documentation locally using either [build-docs.sh](build-docs.sh) or [test-docs.sh](test-docs.sh). diff --git a/build-docs.sh b/build-docs.sh new file mode 100755 index 0000000000000000000000000000000000000000..d025ad765347fe293401f8266e90e88edd826487 --- /dev/null +++ b/build-docs.sh @@ -0,0 +1,4 @@ +pip install sphinx-autodoc2 sphinx_rtd_theme myst-parser + +cd docs/source || exit 1 +make html diff --git a/build_docs.sh b/test-docs.sh similarity index 100% rename from build_docs.sh rename to test-docs.sh