Skip to content

Commit

Permalink
Initial Set up automated Sphinx Documentation with GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
fschwar4 committed May 31, 2024
1 parent 5349f92 commit c7fc7a4
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 186 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Deploy Documentation

on:
push:
branches:
- main # or the branch you want to deploy from

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.x' # replace with your desired Python version

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx
pip install myst-parser
pip install pydata-sphinx-theme
pip install pylint
pip install sphinx-autodoc-typehints
- name: Build documentation
run: |
pwd
sphinx-apidoc -f -o docs/source/_apidoc/ pynamicgain
sphinx-build -b html docs/source docs/_build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
7 changes: 0 additions & 7 deletions docs/source/_apidoc/modules.rst

This file was deleted.

37 changes: 0 additions & 37 deletions docs/source/_apidoc/pynamicgain.rst

This file was deleted.

31 changes: 0 additions & 31 deletions docs/source/_autosummary/pynamicgain.analysis.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/source/_autosummary/pynamicgain.new_setup.rst

This file was deleted.

48 changes: 0 additions & 48 deletions docs/source/_autosummary/pynamicgain.rst

This file was deleted.

33 changes: 0 additions & 33 deletions docs/source/_autosummary/pynamicgain.stimulus_generation.rst

This file was deleted.

0 comments on commit c7fc7a4

Please sign in to comment.