Skip to content

Commit ded8e8b

Browse files
authored
Feat/doc (#11)
* Added Sphinx doc * Fixed GH doc action
1 parent d7d4837 commit ded8e8b

3 files changed

Lines changed: 116 additions & 33 deletions

File tree

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ jobs:
1616
- name: Install Poetry
1717
run: python -m pip install --upgrade pip && pip install poetry
1818
- name: Install project dependencies (including docs)
19-
run: POETRY_VIRTUALENVS_CREATE=false poetry install --no-interaction --with doc
19+
run: poetry install --with doc
2020
- name: Build Sphinx docs
21-
run: sphinx-build -b html docs docs/_build/html
21+
run: poetry run sphinx-build -b html docs docs/_build/html
2222
- name: Deploy to GitHub Pages
2323
uses: peaceiris/actions-gh-pages@v3
2424
with:

poetry.lock

Lines changed: 113 additions & 30 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ dev = [
3838
doc = [
3939
"Sphinx>=5.0",
4040
"furo",
41-
"myst-parser",
41+
"myst-parser (>=5.0.0,<6.0.0)",
4242
]
4343

4444
[tool.black]

0 commit comments

Comments
 (0)