Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test runner image for docs #23

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v2
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.11
- uses: nikeee/setup-pandoc@v1
- name: "Upgrade pip"
run: pip install --upgrade pip
- name: "Install dependencies"
run: pip install .[docs]
run: pip install -e .[docs]
- name: "Run jupyterbook"
run: jupyter-book build docs --all
- name: "Deploy"
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs') }}
with:
publish_branch: gh-pages
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ This method will create a `DeepSensor` directory on your machine which will cont

```{note}
If you intend on contributing to the source code of DeepSensor, install DeepSensor with its development dependencies using
````{bash}
````bash
pip install -v -e .[dev]
````
```
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ docs = [
"jupyter-book",
"matplotlib",
"numpy",
"sphinx",
]
testing = [
"mypy",
Expand Down