File tree Expand file tree Collapse file tree 3 files changed +44
-2
lines changed
Expand file tree Collapse file tree 3 files changed +44
-2
lines changed Original file line number Diff line number Diff line change 1+ name : Deploy Sphinx Documentation
2+
3+ on :
4+ push :
5+ branches :
6+ - main # Trigger the workflow on pushes to the main branch
7+ pull_request :
8+ branches :
9+ - main # Optional: Run workflow for pull requests to the main branch
10+
11+ jobs :
12+ build-and-deploy :
13+ runs-on : ubuntu-latest
14+
15+ steps :
16+ # Step 1: Check out the code
17+ - name : Checkout code
18+ uses : actions/checkout@v3
19+
20+ # Step 2: Set up Python
21+ - name : Set up Python
22+ uses : actions/setup-python@v4
23+ with :
24+ python-version : " 3.10" # Adjust to your preferred Python version
25+
26+ # Step 3: Install dependencies
27+ - name : Install dependencies
28+ run : |
29+ python -m pip install --upgrade pip
30+ pip install sphinx furo # Add any additional dependencies here
31+
32+ # Step 4: Build the documentation
33+ - name : Build Sphinx documentation
34+ run : |
35+ sphinx-build -b html docs/source docs/_build/html
36+
37+ # Step 5: Deploy to GitHub Pages
38+ - name : Deploy to GitHub Pages
39+ uses : peaceiris/actions-gh-pages@v3
40+ with :
41+ github_token : ${{ secrets.GITHUB_TOKEN }}
42+ publish_dir : docs/_build/html
Original file line number Diff line number Diff line change 2121 - name : Set up Python
2222 uses : actions/setup-python@v4
2323 with :
24- python-version : " 3.7 " # Use the Python version your project requires
24+ python-version : " 3.10 " # Use the Python version your project requires
2525
2626 # Install dependencies
2727 - name : Install dependencies
Original file line number Diff line number Diff line change 2424 "pandas>=2.0.0" ,
2525 "tqdm>=4.5.0" ,
2626 ],
27- python_requires = ">=3.7 " , # Minimum Python version
27+ python_requires = ">=3.8 " , # Minimum Python version
2828 classifiers = [ # Metadata for PyPI
2929 "Programming Language :: Python :: 3" ,
3030 "License :: OSI Approved :: MIT License" ,
You can’t perform that action at this time.
0 commit comments