From bb7a75dadee644acd295c7fb9a8ef5d15ac8d802 Mon Sep 17 00:00:00 2001 From: Teresa Pelinski Date: Thu, 8 Aug 2024 16:50:06 +0100 Subject: [PATCH] fixed build path + instructions to build docs --- .github/workflows/deploy-docs.yml | 2 +- docs/docs-readme.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index b700086..e8c6bfb 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -37,4 +37,4 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./_build/html \ No newline at end of file + publish_dir: ./docs/_build/html \ No newline at end of file diff --git a/docs/docs-readme.md b/docs/docs-readme.md index e69de29..e50f9bb 100644 --- a/docs/docs-readme.md +++ b/docs/docs-readme.md @@ -0,0 +1,9 @@ +To build the docs you will need to install `pandoc` to convert the `readme.md` into `rst` (the format used by `sphinx`, the docs builder). You can see the installation instructions [here](https://pandoc.org/installing.html). + +Then you can build the docs with: + +```bash +rm -r docs/_build +pandoc -s readme.md -o docs/readme.rst +pipenv run sphinx-build -M html docs/ docs/_build +```