From b48da816c5c5b0b2a9411aab15731d53e5479fca Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:16:22 +0530 Subject: [PATCH 01/16] Adding github pages for documentation --- .github/workflows/documentation.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 00000000..d3cb678f --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,27 @@ +name: documentation + +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Install dependencies + run: | + pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser + - name: Sphinx build + run: | + sphinx-build docs/source _build + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + with: + publish_branch: github_pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: _build/ + force_orphan: true \ No newline at end of file From 2962dfce184c5b862cb90033c5f94ec018ea8545 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:18:52 +0530 Subject: [PATCH 02/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d3cb678f..ff05abc8 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/setup-python@v5 - name: Install dependencies run: | - pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser + pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser "sphinx-autobuild==2024.10.3" - name: Sphinx build run: | sphinx-build docs/source _build From ff67153b24a669bc323889ea86f2892c683174d0 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:21:24 +0530 Subject: [PATCH 03/16] Modifying github actions for documentation --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index a21bfd98..e6482cd6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ "sphinx.ext.autosectionlabel", "sphinx.ext.viewcode", "sphinx.ext.todo", - "sphinxcontrib.autodoc_pydantic", + "autodoc_pydantic", "sphinx_copybutton", "sphinx_click", "sphinx.ext.githubpages", From cb77aaefc45f6c3324e3ecf6f45217a89523b240 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:23:07 +0530 Subject: [PATCH 04/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index ff05abc8..e34cae3d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/setup-python@v5 - name: Install dependencies run: | - pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser "sphinx-autobuild==2024.10.3" + pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser autodoc-pydantic "sphinx-autobuild==2024.10.3" - name: Sphinx build run: | sphinx-build docs/source _build From 849e0acd38914c33664584608a1450ceb73cc99f Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:27:01 +0530 Subject: [PATCH 05/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index e34cae3d..764b7949 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -11,12 +11,20 @@ jobs: steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 + - name: Install dependencies run: | - pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" "sphinx-click==6.0.0" sphinx_rtd_theme myst_parser autodoc-pydantic "sphinx-autobuild==2024.10.3" + pip install --upgrade pip + pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" \ + "sphinx-click==6.0.0" "sphinx_rtd_theme" "myst_parser" \ + "autodoc-pydantic==2.2.0" "sphinx-autobuild==2024.10.3" + + - name: Verify installation + run: pip show autodoc-pydantic + - name: Sphinx build - run: | - sphinx-build docs/source _build + run: sphinx-build docs/source _build + - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} @@ -24,4 +32,4 @@ jobs: publish_branch: github_pages github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _build/ - force_orphan: true \ No newline at end of file + force_orphan: true From 4bfe1e481224baba5a52f1783fda86b71b3bd186 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:29:23 +0530 Subject: [PATCH 06/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 764b7949..60ba484b 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -14,16 +14,17 @@ jobs: - name: Install dependencies run: | + cd docs pip install --upgrade pip pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" \ "sphinx-click==6.0.0" "sphinx_rtd_theme" "myst_parser" \ "autodoc-pydantic==2.2.0" "sphinx-autobuild==2024.10.3" - name: Verify installation - run: pip show autodoc-pydantic + run: cd docs && pip show autodoc-pydantic - name: Sphinx build - run: sphinx-build docs/source _build + run: cd docs && rm -rf _build && sphinx-build source _build - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 From 47e54fe696e1d472c975eae063e56d94b6d0a893 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:32:42 +0530 Subject: [PATCH 07/16] Modifying github actions for documentation --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e6482cd6..c8ef9547 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ "sphinx.ext.autosectionlabel", "sphinx.ext.viewcode", "sphinx.ext.todo", - "autodoc_pydantic", + "sphinx.ext.autodoc_pydantic", "sphinx_copybutton", "sphinx_click", "sphinx.ext.githubpages", From 33f359cbbf16f471d2f95f83990949f9ea642aba Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:35:42 +0530 Subject: [PATCH 08/16] Modifying github actions for documentation --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index c8ef9547..a21bfd98 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,7 +22,7 @@ "sphinx.ext.autosectionlabel", "sphinx.ext.viewcode", "sphinx.ext.todo", - "sphinx.ext.autodoc_pydantic", + "sphinxcontrib.autodoc_pydantic", "sphinx_copybutton", "sphinx_click", "sphinx.ext.githubpages", From ef4b64a582229deccf3051adc4ed1bb294b7cb22 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:38:00 +0530 Subject: [PATCH 09/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 60ba484b..63d07210 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -18,7 +18,8 @@ jobs: pip install --upgrade pip pip install "sphinx==8.1.3" "sphinx-copybutton==0.5.2" "sphinx-hoverxref==1.4.1" \ "sphinx-click==6.0.0" "sphinx_rtd_theme" "myst_parser" \ - "autodoc-pydantic==2.2.0" "sphinx-autobuild==2024.10.3" + "autodoc-pydantic==2.2.0" "sphinx-autobuild==2024.10.3" "furo==2024.8.6" \ + "linkify-it-py==2.0.3" - name: Verify installation run: cd docs && pip show autodoc-pydantic From a5b5f1e6c9dccf857c16ece1c152ec0c19a66faf Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:54:47 +0530 Subject: [PATCH 10/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 63d07210..15c32dce 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -27,11 +27,14 @@ jobs: - name: Sphinx build run: cd docs && rm -rf _build && sphinx-build source _build + - name: List build files + run: ls -R _build/html + - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} with: publish_branch: github_pages github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: _build/ + publish_dir: _build/html force_orphan: true From d4a59b0a4387c130892c0ac3b5b547d32e40371b Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:55:44 +0530 Subject: [PATCH 11/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 15c32dce..65018027 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -28,7 +28,7 @@ jobs: run: cd docs && rm -rf _build && sphinx-build source _build - name: List build files - run: ls -R _build/html + run: ls -R docs/_build/html - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 From f2e54dd468c9a23cdc878fba0d01e18b6ac222b1 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 11:57:10 +0530 Subject: [PATCH 12/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 65018027..f4e61d43 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -28,7 +28,7 @@ jobs: run: cd docs && rm -rf _build && sphinx-build source _build - name: List build files - run: ls -R docs/_build/html + run: ls -R docs/_build - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 @@ -36,5 +36,5 @@ jobs: with: publish_branch: github_pages github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: _build/html + publish_dir: _build force_orphan: true From 51d997d5cf380574d6c6a75868eba6793b2e4bd6 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 12:05:21 +0530 Subject: [PATCH 13/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index f4e61d43..4dfe1aa7 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -38,3 +38,4 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _build force_orphan: true + clean: true From b1d4ea87023e9154d1f9a7e73e20c2c7553491f2 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 13:30:03 +0530 Subject: [PATCH 14/16] Adds a .nojekyll file for docs builds --- docs/.nojekyll | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/.nojekyll diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 00000000..e69de29b From 03d866e001972e748e4cc73c61f2b45b429e1af8 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 17:59:51 +0530 Subject: [PATCH 15/16] Adds a .nojekyll file for docs builds --- .github/workflows/documentation.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4dfe1aa7..f4e61d43 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -38,4 +38,3 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: _build force_orphan: true - clean: true From 655ccf965f16a98fdd4811584fb0eee352150a57 Mon Sep 17 00:00:00 2001 From: Tanvi Johari Date: Tue, 5 Nov 2024 18:04:07 +0530 Subject: [PATCH 16/16] Modifying github actions for documentation --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index f4e61d43..514056d3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -36,5 +36,5 @@ jobs: with: publish_branch: github_pages github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: _build + publish_dir: docs/_build force_orphan: true