From 35dca332e1035cabcd80622014dd46db23f944a1 Mon Sep 17 00:00:00 2001 From: gituser789 <62549000+gituser789@users.noreply.github.com> Date: Wed, 8 May 2024 11:15:04 +0200 Subject: [PATCH 1/6] add docu workflow --- .github/workflows/sphinx_render_docs.yml | 35 ++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/sphinx_render_docs.yml diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml new file mode 100644 index 0000000..1088e21 --- /dev/null +++ b/.github/workflows/sphinx_render_docs.yml @@ -0,0 +1,35 @@ +name: "Sphinx: Render docs" + +on: push + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.8' + - uses: actions/checkout@v4 + - name: Install sphinx and build documentation with sphinx + run: | + python --version + pip install sphinx sphinx_rtd_theme sphinxcontrib-email + pip install -e . + - name: Build HTML + uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + - 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 From 9b1b9d1bc6240698281ef49e9a3751730b83042a Mon Sep 17 00:00:00 2001 From: gituser789 <62549000+gituser789@users.noreply.github.com> Date: Wed, 8 May 2024 11:17:01 +0200 Subject: [PATCH 2/6] update readme path --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 5b850df..c7ba630 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ authors = [ { name = "UPB-LEA" }, ] description = "Control GeckoCircuits by using python." -readme = "README.md" +readme = "README.rst" requires-python = "~=3.8" classifiers = [ "Programming Language :: Python :: 3", From fb74888248149caac69f8e44ce227641224ee6cb Mon Sep 17 00:00:00 2001 From: gituser789 <62549000+gituser789@users.noreply.github.com> Date: Wed, 8 May 2024 11:20:29 +0200 Subject: [PATCH 3/6] add rtd-theme to pre-build --- .github/workflows/sphinx_render_docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml index 1088e21..8d9c77a 100644 --- a/.github/workflows/sphinx_render_docs.yml +++ b/.github/workflows/sphinx_render_docs.yml @@ -22,6 +22,7 @@ jobs: uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" + pre-build-command: "pip install sphinx_rtd_theme" - name: Upload artifacts uses: actions/upload-artifact@v4 with: From eebcfb91129217d182a845c595b03c4d097ac6c2 Mon Sep 17 00:00:00 2001 From: gituser789 <62549000+gituser789@users.noreply.github.com> Date: Wed, 8 May 2024 11:27:13 +0200 Subject: [PATCH 4/6] trial --- .github/workflows/sphinx_render_docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml index 8d9c77a..53e85d5 100644 --- a/.github/workflows/sphinx_render_docs.yml +++ b/.github/workflows/sphinx_render_docs.yml @@ -11,7 +11,7 @@ jobs: - name: Setup Python uses: actions/setup-python@v5 with: - python-version: '3.8' + python-version: '3.10' - uses: actions/checkout@v4 - name: Install sphinx and build documentation with sphinx run: | @@ -22,7 +22,7 @@ jobs: uses: ammaraskar/sphinx-action@master with: docs-folder: "docs/" - pre-build-command: "pip install sphinx_rtd_theme" + pre-build-command: "pip install sphinx_rtd_theme sphinxcontrib-email" - name: Upload artifacts uses: actions/upload-artifact@v4 with: From aa4c4dced89e39130f2f42e5c3243640f205276f Mon Sep 17 00:00:00 2001 From: gituser789 <62549000+gituser789@users.noreply.github.com> Date: Wed, 8 May 2024 11:29:33 +0200 Subject: [PATCH 5/6] trial --- .github/workflows/sphinx_render_docs.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml index 53e85d5..e457bf8 100644 --- a/.github/workflows/sphinx_render_docs.yml +++ b/.github/workflows/sphinx_render_docs.yml @@ -18,11 +18,13 @@ jobs: python --version pip install sphinx sphinx_rtd_theme sphinxcontrib-email pip install -e . - - name: Build HTML - uses: ammaraskar/sphinx-action@master - with: - docs-folder: "docs/" - pre-build-command: "pip install sphinx_rtd_theme sphinxcontrib-email" + cd docs/source + make html +# - name: Build HTML +# uses: ammaraskar/sphinx-action@master +# with: +# docs-folder: "docs/" +# pre-build-command: "pip install sphinx_rtd_theme sphinxcontrib-email" - name: Upload artifacts uses: actions/upload-artifact@v4 with: From 8c74e01fc87f99b4ef9766c2b77135c4a0d7cb1d Mon Sep 17 00:00:00 2001 From: gituser789 <62549000+gituser789@users.noreply.github.com> Date: Wed, 8 May 2024 11:29:51 +0200 Subject: [PATCH 6/6] trial --- .github/workflows/sphinx_render_docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml index e457bf8..0032299 100644 --- a/.github/workflows/sphinx_render_docs.yml +++ b/.github/workflows/sphinx_render_docs.yml @@ -18,7 +18,7 @@ jobs: python --version pip install sphinx sphinx_rtd_theme sphinxcontrib-email pip install -e . - cd docs/source + cd docs make html # - name: Build HTML # uses: ammaraskar/sphinx-action@master