Skip to content

Commit

Permalink
Add docs build workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
aadya940 committed Feb 10, 2024
1 parent f7b5760 commit afb3da3
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,36 @@ jobs:

- name: Check Code Formatting
run: black --check .

build-docs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.9', '3.10', '3.11']

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

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{matrix.python-version}}

- name: Install Doc dependencies
run: pip install -r requirements_doc.txt

- name: Run apidoc
run: sphinx-apidoc -o docs/source chainopy/

- name: Navigate to doc root
run: cd docs

- name: Make docs
run: make html

- name: Navigate to docs build
run: cd build/html

- name: View docs
run: python -m http.server

0 comments on commit afb3da3

Please sign in to comment.