Skip to content

Commit

Permalink
[doc] update doc build workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
unitasium committed Sep 19, 2024
1 parent 228fa85 commit 8dece34
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
33 changes: 33 additions & 0 deletions .github/workflows/build_sphinx_doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: sphinx build doc html

on:
push:
branches:
- main

jobs:
build-html:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.9'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r sgio/docs/requirements.txt
- name: Build HTML
run: |
cd sgio/docs
make html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true
9 changes: 9 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
sphinx
sphinx-comments
sphinx-sitemap
sphinx-design
sphinx-gallery
pydata-sphinx-theme
sphinx-prompt
sphinx-copybutton
myst-parser
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_book_theme'
# html_theme = 'sphinx_book_theme'
html_theme = 'pydata_sphinx_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down

0 comments on commit 8dece34

Please sign in to comment.