From aa20cf09986796c1dc2bb8b2a9f151e209606f52 Mon Sep 17 00:00:00 2001 From: marcosf2 Date: Fri, 23 Jan 2026 16:57:40 -0600 Subject: [PATCH 1/5] minor fixes --- .github/workflows/documentation.yml | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 07deac7..ce43457 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -18,7 +18,8 @@ concurrency: cancel-in-progress: false jobs: - build: + deploy: + if: github.ref == 'refs/heads/main' && github.event_name == 'push' runs-on: ubuntu-latest steps: - name: Checkout repository @@ -28,23 +29,15 @@ jobs: uses: conda-incubator/setup-miniconda@v3 with: environment-file: environment.yml + cache-environment: true + cache-downloads: true + - name: Build documentation shell: bash -l {0} run: make html - - name: Upload artifact - uses: actions/upload-pages-artifact@v4 - with: - path: 'build/html' - - deploy: - if: github.ref == 'refs/heads/main' && github.event_name == 'push' - needs: build - 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@v2 \ No newline at end of file + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build/html \ No newline at end of file From 444963e8226edb46bf77f8cb62219278d92fbce6 Mon Sep 17 00:00:00 2001 From: marcosf2 Date: Fri, 23 Jan 2026 17:00:58 -0600 Subject: [PATCH 2/5] minor fixes --- .github/workflows/documentation.yml | 43 ----------------------------- .github/workflows/sphinx.yml | 26 +++++++++++++++++ 2 files changed, 26 insertions(+), 43 deletions(-) delete mode 100644 .github/workflows/documentation.yml create mode 100644 .github/workflows/sphinx.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml deleted file mode 100644 index ce43457..0000000 --- a/.github/workflows/documentation.yml +++ /dev/null @@ -1,43 +0,0 @@ -name: Build and Deploy Documentation - -on: - push: - branches: - - main - pull_request: - branches: - - main - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: "pages" - cancel-in-progress: false - -jobs: - deploy: - if: github.ref == 'refs/heads/main' && github.event_name == 'push' - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Set up Conda - uses: conda-incubator/setup-miniconda@v3 - with: - environment-file: environment.yml - cache-environment: true - cache-downloads: true - - - name: Build documentation - shell: bash -l {0} - run: make html - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./build/html \ No newline at end of file diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml new file mode 100644 index 0000000..b64d808 --- /dev/null +++ b/.github/workflows/sphinx.yml @@ -0,0 +1,26 @@ +name: "Sphinx: Render docs" + +on: push + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + - name: Build HTML + uses: ammaraskar/sphinx-action@master + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: docs/build/html/ + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/build/html \ No newline at end of file From 0ebc5c56c9fb7086bd9de934f3ad20115803fa29 Mon Sep 17 00:00:00 2001 From: marcosf2 Date: Fri, 23 Jan 2026 17:01:54 -0600 Subject: [PATCH 3/5] rename doc to docs --- {doc => docs}/_static/logo.png | Bin {doc => docs}/conf.py | 0 {doc => docs}/contributing/index.md | 0 {doc => docs}/contributing/setting_up.md | 0 {doc => docs}/examples/index.md | 0 {doc => docs}/examples/intro.md | 0 {doc => docs}/examples/qubit.md | 0 {doc => docs}/index.md | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename {doc => docs}/_static/logo.png (100%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/contributing/index.md (100%) rename {doc => docs}/contributing/setting_up.md (100%) rename {doc => docs}/examples/index.md (100%) rename {doc => docs}/examples/intro.md (100%) rename {doc => docs}/examples/qubit.md (100%) rename {doc => docs}/index.md (100%) diff --git a/doc/_static/logo.png b/docs/_static/logo.png similarity index 100% rename from doc/_static/logo.png rename to docs/_static/logo.png diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/contributing/index.md b/docs/contributing/index.md similarity index 100% rename from doc/contributing/index.md rename to docs/contributing/index.md diff --git a/doc/contributing/setting_up.md b/docs/contributing/setting_up.md similarity index 100% rename from doc/contributing/setting_up.md rename to docs/contributing/setting_up.md diff --git a/doc/examples/index.md b/docs/examples/index.md similarity index 100% rename from doc/examples/index.md rename to docs/examples/index.md diff --git a/doc/examples/intro.md b/docs/examples/intro.md similarity index 100% rename from doc/examples/intro.md rename to docs/examples/intro.md diff --git a/doc/examples/qubit.md b/docs/examples/qubit.md similarity index 100% rename from doc/examples/qubit.md rename to docs/examples/qubit.md diff --git a/doc/index.md b/docs/index.md similarity index 100% rename from doc/index.md rename to docs/index.md From 0984e596e37ed279d2e2d8d6ce0e1dcbcfae8088 Mon Sep 17 00:00:00 2001 From: marcosf2 Date: Mon, 26 Jan 2026 10:25:41 -0600 Subject: [PATCH 4/5] Added makefile to docs directory --- docs/Makefile | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/Makefile diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..b507a95 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file From 81769aac8d865bdfbc9c6fa318a8c222e8086f6f Mon Sep 17 00:00:00 2001 From: marcosf2 Date: Mon, 26 Jan 2026 10:27:40 -0600 Subject: [PATCH 5/5] Setup conda --- .github/workflows/sphinx.yml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index b64d808..4732470 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -11,8 +11,15 @@ jobs: - uses: actions/checkout@v4 with: persist-credentials: false + - name: Set up conda + uses: conda-incubator/setup-miniconda@v3 + with: + auto-activate-base: true + activate-environment: tfe-docs + environment-file: environment.yml - name: Build HTML - uses: ammaraskar/sphinx-action@master + shell: bash -l {0} + run: cd docs && make html - name: Upload artifacts uses: actions/upload-artifact@v4 with: