Skip to content

Commit

Permalink
prepare github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
dnguyend committed Jun 4, 2024
1 parent bcc1be3 commit bc96b90
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Deploy Sphinx documentation to Pages

on:
push:
branches: [main] # branch to trigger deployment
pull_request:
branches: [main]
workflow_dispatch:

# allow manually trigger the action


permissions:
contents: write
id-token: write

jobs:
pages:
runs-on: ubuntu-20.04
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- id: deployment
uses: sphinx-notes/pages@v3
with:
documentation_path: ./docs/source
4 changes: 4 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O);
cd _build; git worktree add -f html gh-pages
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ authors = [
{ name="Stefan Sommer", email="[email protected]" },
{ name="Du Nguyen", email="[email protected]" },
]
description = "Tree traversals using jax"
description = "Riemannian Brownian motion using jax"
readme = "README.md"
requires-python = ">=3.8"
classifiers = [
Expand All @@ -14,6 +14,7 @@ classifiers = [
]
dependencies = [
"jax",
"jaxlib",
]
dynamic = ["version"]

Expand Down

0 comments on commit bc96b90

Please sign in to comment.