Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinx to gh workflow #355

Merged
merged 8 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# For reference: https://github.com/JamesIves/github-pages-deploy-action
name: Build Sphinx docu.

on:
release:
types: [published]
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install and Build HTML
run: |
pip install --upgrade pip
pip install sphinx sphinx-rtd-theme
pip install ".[full]"
sphinx-build ./docs/source ./docs/build

- name: Deploy HTML
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/build/ # The folder the action should deploy.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
],
'plot': ['plotly<5.0'],
'pynumpress': ['pynumpress>=0.0.4'],
'deconvolution': ['ms_deisotope==0.0.14']
'deconvolution': ['ms_deisotope==0.0.14']
},
description = 'high-throughput mzML parsing',
long_description = 'pymzML - python module for mzML parsing',
Expand Down