diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..7085f83 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,48 @@ +name: Build & Publish Docs + +on: + push: + branches: + - main + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + build-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - name: Install uv + uses: astral-sh/setup-uv@v6 + + - name: Install nxlib and dev dependencies + run: uv sync --dev + + - name: Build documentation + run: uv run python scripts/generate_docs.py doc_build + + - name: Upload GitHub Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: doc_build + + deploy: + needs: build-docs + if: github.ref == 'refs/heads/main' && github.event_name == 'push' + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/pyproject.toml b/pyproject.toml index 0c18ff2..9fc02a4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,7 +44,7 @@ dependencies = [ [project.urls] Homepage = "https://github.com/cfs-energy/nxlib" -# TODO (SW-14420): Add URL for documentation +Documentation = "https://cfs-energy.github.io/nxlib/" Repository = "https://github.com/cfs-energy/nxlib" Issues = "https://github.com/cfs-energy/nxlib/issues" Changelog = "https://github.com/cfs-energy/nxlib/blob/main/CHANGELOG.md"