From a097dd50d22c20098915074f375f0bae820a7dd8 Mon Sep 17 00:00:00 2001 From: gnzng Date: Sun, 2 Mar 2025 13:05:39 -0800 Subject: [PATCH 1/2] Update .gitignore to include .DS_Store files --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index dcb9f36..b126f78 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,5 @@ docs/build build/* dist */example_data/* -*.h5 \ No newline at end of file +*.h5 +.DS_Store \ No newline at end of file From e1b76f09591d368916cf2f00e53797f7a0c1e6f7 Mon Sep 17 00:00:00 2001 From: gnzng Date: Sun, 2 Mar 2025 13:07:30 -0800 Subject: [PATCH 2/2] DOCS: Force-Push due to rebasing unnecessary large commits to just add an extra doc publishing action --- .github/workflows/main.yml | 58 ++++++++++++++++++++++++++++++++++++ .gitignore | 1 + docs/source/installation.rst | 2 +- 3 files changed, 60 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6502b1d..55adfa6 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -30,3 +30,61 @@ jobs: - name: Run tests run: pytest + + build-docs: + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + runs-on: ubuntu-latest + permissions: + contents: read + pages: write + id-token: write + + concurrency: + group: "pages" + cancel-in-progress: false + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.9' + + - name: Install dependencies + run: | + pip install --upgrade pip + pip install -r requirements.txt + pip install sphinx sphinx_rtd_theme sphinx-argparse + pip install -e . --no-deps + + - name: Build docs + working-directory: docs + run: | + make html + + - name: List files in docs/build/html + run: | + ls -la docs/build/html + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/build/html' + name: github-pages + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} + timeout: 600000 + error_count: 10 + reporting_interval: 5000 + artifact_name: github-pages + preview: false \ No newline at end of file diff --git a/.gitignore b/.gitignore index b126f78..ea4c46c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ *.egg-info .pytest_cache docs/build +docs/_build build/* dist */example_data/* diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 1b3f2ba..d998f93 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -8,7 +8,7 @@ The source code for CDTools is hosted on `Github`_. At the moment, the repositor .. _`Github`: https://github.com/cdtools-developers/cdtools -The repository remains under active development as of late 2024. +The repository remains under active development as of early 2025. Step 2: Install Dependencies ----------------------------