Skip to content

Commit

Permalink
fixed build path + instructions to build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pelinski committed Aug 8, 2024
1 parent e782b04 commit bb7a75d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ jobs:
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./_build/html
publish_dir: ./docs/_build/html
9 changes: 9 additions & 0 deletions docs/docs-readme.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit bb7a75d

Please sign in to comment.