From 02818528ff3ccd5f8ff99b7b3529ff02ac110618 Mon Sep 17 00:00:00 2001 From: Karel van Klink <karel.vanklink@geant.org> Date: Fri, 7 Jul 2023 10:03:26 +0200 Subject: [PATCH] add build-docs.sh for publishing documentation --- README.md | 2 +- build-docs.sh | 4 ++++ build_docs.sh => test-docs.sh | 0 3 files changed, 5 insertions(+), 1 deletion(-) create mode 100755 build-docs.sh rename build_docs.sh => test-docs.sh (100%) diff --git a/README.md b/README.md index 29a7ebdb..2056188c 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 00000000..d025ad76 --- /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 -- GitLab