Update workflow, remove docs folder

oasisprotocol · Dec 4, 2024 · 8fb8e5b · 8fb8e5b
1 parent 64e7a8f
commit 8fb8e5b
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 148 deletions.
diff --git a/.github/workflows/ci-docs.yaml b/.github/workflows/ci-docs.yaml
@@ -8,13 +8,6 @@ on:
       - clients/py/**
     branches:
       - main
-  pull_request:
-    paths:
-      - clients/js/**
-      - contracts/**
-      - clients/py/**
-    branches:
-      - main
 
 # Cancel in-progress jobs on same branch.
 concurrency:
@@ -165,12 +158,26 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements.txt
           pip install -r requirements.dev.txt
-          pip install sphinx sphinx-rtd-theme myst-parser
+          pip install sphinx myst-parser
           make
           pip install dist/sapphire.py-*.whl
 
       - name: Build docs
         run: |
+          mkdir docs
+          cd docs
+          sphinx-quickstart --quiet --sep --project=sapphirepy --copyright="2024, Oasis Protocol Foundation" --author="[email protected]" --ext-autodoc --ext-viewcode
+          pip install furo
+          sed -i "s/^html_theme = 'alabaster'/html_theme = 'furo'/" source/conf.py
+          # Modify conf.py programmatically
+          sed -i "s/^extensions = \[/extensions = [\n    'myst_parser',/" source/conf.py
+          echo "source_suffix = {'.rst': 'restructuredtext', '.md': 'markdown'}" >> source/conf.py
+          
+          sed -i '/^Add your content/,/details\.$/d; /^sapphirepy documentation$/,/^=\+$/c\sapphirepy documentation\n========================\n\n.. automodule:: sapphirepy\n   :members:\n   :undoc-members:\n   :show-inheritance:\n\n.. include:: ../../README.md\n   :parser: markdown\n' source/index.rst
+          echo -e "\n   modules" >> source/index.rst
+          cd ..  # Back to project root
+          sphinx-apidoc -o docs/source/ $(pip show sapphire-py | grep Location | cut -d' ' -f2)/sapphirepy
+          
           cd docs
           make html
 

diff --git a/clients/py/docs/Makefile b/clients/py/docs/Makefile
diff --git a/clients/py/docs/source/.nojekyll b/clients/py/docs/source/.nojekyll
diff --git a/clients/py/docs/source/conf.py b/clients/py/docs/source/conf.py
diff --git a/clients/py/docs/source/index.rst b/clients/py/docs/source/index.rst
diff --git a/clients/py/docs/source/modules.rst b/clients/py/docs/source/modules.rst
diff --git a/clients/py/docs/source/sapphirepy.rst b/clients/py/docs/source/sapphirepy.rst
diff --git a/clients/py/setup.py b/clients/py/setup.py
@@ -30,7 +30,4 @@
     url="https://github.com/oasisprotocol/sapphire-paratime",
     version="0.3.0",
     zip_safe=True,
-    package_data={
-        'sapphirepy': ['docs/*.html'],  # Include all HTML docs
-    },
 )