Skip to content

Commit

Permalink
requirements.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
tanishiking committed Oct 2, 2023
1 parent 55f9e90 commit 0604893
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,5 @@ jobs:
- uses: actions/checkout@v3
- uses: ammaraskar/sphinx-action@0.4
with:
pre-build-command: "pip install Sphinx==7.0.1 recommonmark==0.7.1"
docs-folder: "docs/"
build-command: 'sphinx-build -b html . _build/html -W --keep-going -n'
build-command: 'sphinx-build -b html . _build/html -W --keep-going -n'
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
furo==2023.9.10

Check warning on line 1 in docs/requirements.txt

View workflow job for this annotation

GitHub Actions / build-docs

document isn't included in any toctree
recommonmark==0.7.1
Sphinx==7.2.6
sphinx-last-updated-by-git==0.3.6
9 changes: 3 additions & 6 deletions scripts/makedocs
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@
#!/usr/bin/env bash
cd docs
function create_venv {
virtualenv .venv
python -m venv .venv
}

function activate_venv {
source .venv/bin/activate
}

function install_req {
pip install Sphinx==4.2.0
pip install furo==2023.9.10
pip install sphinx-last-updated-by-git==0.3.6
pip install recommonmark==0.7.1
pip install -r ../docs/requirements.txt
}

function generate_docs {
make html
SPHINX_OPTS="-W" make html
}

function usage {
Expand Down

0 comments on commit 0604893

Please sign in to comment.