Skip to content

update docs

update docs #11

Workflow file for this run

name: Build and Deploy Sphinx Documentation
on:
push:
branches:
- main
jobs:
build-and-deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme nbsphinx
pip install .
pip freeze
sudo apt-get install pandoc
- name: Debug environment
run: |
pwd
ls -R
python -c "import pandalchemy; print(pandalchemy.__file__)"
python -c "from pandalchemy import methods; print(methods.__file__)"
- name: Build Documentation
run: |
cd docs
make html
echo "Contents of _build/html directory:"
ls -R _build/html
continue-on-error: true
- name: Debug Build Output
if: always()
run: |
echo "Current directory:"
pwd
echo "Contents of docs/_build directory:"
ls -R docs/_build
- name: Display Sphinx build log
if: failure()
run: cat /tmp/sphinx-log
- name: Check build output
run: |
ls -R docs/_build/html
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html
clean: true # Removes existing files from the branch, ensuring a clean slate
clean-exclude: |
.nojekyll
- name: Add .nojekyll file
run: |
cd docs/_build/html
touch .nojekyll