diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml new file mode 100644 index 0000000..dd594f3 --- /dev/null +++ b/.github/workflows/sphinx_render_docs.yml @@ -0,0 +1,45 @@ +name: "Sphinx: Render docs" + +on: + # Triggers the workflow on push or pull request events but only for the main branch + push: + branches: [ main] + pull_request: + branches: [ main ] + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + - 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 . + cd docs + 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: + 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 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",