Skip to content

Commit

Permalink
Merge pull request #75 from NREL/sphinx
Browse files Browse the repository at this point in the history
Add sphinx documentation instead of readmes
  • Loading branch information
fmuni authored Dec 16, 2024
2 parents e41e4c4 + c5b9acd commit 90de193
Show file tree
Hide file tree
Showing 18 changed files with 801 additions and 333 deletions.
2 changes: 1 addition & 1 deletion .github/linters/.codespellrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[codespell]
skip = None, .git,OFsolvers,tutorial_cases,experimental_cases,build,__pycache__,data_conditional_mean,Figures,assets
skip = None, .git,OFsolvers,tutorial_cases,experimental_cases,build,_build,__pycache__,data_conditional_mean,Figures,assets
ignore-words = .github/linters/.codespell-ignore-words
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
working-directory: ${{github.workspace}}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: ${{matrix.python-version}}
- name: Install dependencies
Expand All @@ -56,7 +56,7 @@ jobs:
working-directory: ${{github.workspace}}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: ${{matrix.python-version}}
- name: Install dependencies
Expand Down Expand Up @@ -86,7 +86,7 @@ jobs:
working-directory: ${{github.workspace}}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: ${{matrix.python-version}}
- uses: gerlero/setup-openfoam@v1
Expand Down
45 changes: 45 additions & 0 deletions .github/workflows/docs_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: BiRD-documentation

on:
push:
branches: [ main ]
paths:
- 'docs/**'
- '.github/workflows/docs_pages.yml'

jobs:

build_docs:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
cache: 'pip'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme
- name: Build documentation
run: |
cd docs
make html
- name: deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
force_orphan: true
full_commit_message: ${{ github.event.head_commit.message }}


Loading

0 comments on commit 90de193

Please sign in to comment.