Skip to content

Commit

Permalink
Update docs GHA
Browse files Browse the repository at this point in the history
  • Loading branch information
dfsnow committed Jul 24, 2024
1 parent 07a03eb commit 5a0c62a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
16 changes: 9 additions & 7 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Configure pages
uses: actions/configure-pages@v5

- name: Setup python
uses: actions/setup-python@v5

- name: Generate HTML
run: |
python -m pip install sphinx myst_nb pydata_sphinx_theme ipykernel pandas statsmodels matplotlib
python -m pip install .
pip install .[docs]
sphinx-build -d _build/doctrees docs/source _build/html
- name: Configure pages
uses: actions/configure-pages@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
uses: actions/upload-pages-artifact@v3
with:
path: '_build/html'

Expand All @@ -41,4 +43,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ __pycache__/
junit/
coverage.xml
coverage.html
_build/

# Local virtualenv directory
venv/
7 changes: 7 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ test = [
"pytest >= 7.3.0",
"pytest-cov >= 4.1.0",
]
docs = [
"myst-nb >= 1.1.0",
"sphinx >= 7.0.0",
"pydata-sphinx-theme >= 0.15.0",
"ipykernel >= 6.0.0",
"matplotlib >= 3.0.0"
]

[tool.setuptools]
include-package-data = true
Expand Down

0 comments on commit 5a0c62a

Please sign in to comment.