Skip to content
This repository has been archived by the owner on Apr 21, 2024. It is now read-only.

Commit

Permalink
Update documentation.yaml and pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
teobucci committed Feb 16, 2024
1 parent 35c101f commit ee5b30a
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
32 changes: 32 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: documentation

on: [push, pull_request, workflow_dispatch]

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install Pandoc
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install dependencies
run: |
pip install ".[docs]"
python -m ipykernel install --user --name python3
- name: Sphinx build
run: |
sphinx-build docs/source docs/build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/
force_orphan: true
12 changes: 11 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ dependencies = [
"numpy",
"pandas",
"matplotlib", # Add other dependencies as required
"scipy",
]

[project.urls]
Expand All @@ -36,7 +37,16 @@ Documentation = "https://github.com/teobucci/tefs"
Repository = "https://github.com/teobucci/tefs"

[project.optional-dependencies]
docs = ["sphinx", "sphinx-rtd-theme", "myst-parser", "nbsphinx"]
docs = [
"sphinx",
"sphinx-rtd-theme",
"myst-parser",
"nbsphinx",
"ipykernel",
"jupyter",
"jupyterlab",
"nbconvert",
]

[tool.bumpver]
current_version = "0.1.0"
Expand Down

0 comments on commit ee5b30a

Please sign in to comment.