ignore pages build files + tweak docs workflow

geo-martino · Jan 6, 2024 · 725861a · 725861a
1 parent e963955
commit 725861a
Show file tree

Hide file tree

Showing 69 changed files with 7 additions and 17,435 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -12,23 +12,20 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
 
-      - name: Install dependencies
+      - name: Install module
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser
-
-      - name: Sphinx generate structure
-        run: |
-          sphinx-apidoc -o doc src
+          pip install -e '.[docs]'
 
       - name: Sphinx build
         run: |
-          sphinx-build doc _build
+          sphinx-apidoc -o doc src
+          sphinx-build doc .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: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: _build/
+          publish_dir: .build/
           force_orphan: true
diff --git a/.gitignore b/.gitignore
@@ -20,9 +20,10 @@ config.yml
 # caches
 **cache*
 
-# build/dev directories
+# build/dev/doc directories
 dist/
 .grip/
+.build/
 
 # large data & log folders
 _data/

diff --git a/_build/.buildinfo b/_build/.buildinfo
diff --git a/_build/.doctrees/environment.pickle b/_build/.doctrees/environment.pickle
diff --git a/_build/.doctrees/index.doctree b/_build/.doctrees/index.doctree
diff --git a/_build/.doctrees/modules.doctree b/_build/.doctrees/modules.doctree
diff --git a/_build/.doctrees/syncify.abstract.doctree b/_build/.doctrees/syncify.abstract.doctree
diff --git a/_build/.doctrees/syncify.api.doctree b/_build/.doctrees/syncify.api.doctree
diff --git a/_build/.doctrees/syncify.doctree b/_build/.doctrees/syncify.doctree
diff --git a/_build/.doctrees/syncify.local.doctree b/_build/.doctrees/syncify.local.doctree
diff --git a/_build/.doctrees/syncify.local.library.doctree b/_build/.doctrees/syncify.local.library.doctree
diff --git a/_build/.doctrees/syncify.local.playlist.doctree b/_build/.doctrees/syncify.local.playlist.doctree
diff --git a/_build/.doctrees/syncify.local.track.doctree b/_build/.doctrees/syncify.local.track.doctree
diff --git a/_build/.doctrees/syncify.processors.doctree b/_build/.doctrees/syncify.processors.doctree
diff --git a/_build/.doctrees/syncify.remote.doctree b/_build/.doctrees/syncify.remote.doctree
diff --git a/_build/.doctrees/syncify.remote.processors.doctree b/_build/.doctrees/syncify.remote.processors.doctree
diff --git a/_build/.doctrees/syncify.spotify.api.doctree b/_build/.doctrees/syncify.spotify.api.doctree
diff --git a/_build/.doctrees/syncify.spotify.doctree b/_build/.doctrees/syncify.spotify.doctree
diff --git a/_build/.doctrees/syncify.spotify.processors.doctree b/_build/.doctrees/syncify.spotify.processors.doctree
diff --git a/_build/.doctrees/syncify.utils.doctree b/_build/.doctrees/syncify.utils.doctree
diff --git a/_build/_sources/index.rst.txt b/_build/_sources/index.rst.txt
diff --git a/_build/_sources/modules.rst.txt b/_build/_sources/modules.rst.txt
diff --git a/_build/_sources/syncify.abstract.rst.txt b/_build/_sources/syncify.abstract.rst.txt
diff --git a/_build/_sources/syncify.api.rst.txt b/_build/_sources/syncify.api.rst.txt
diff --git a/_build/_sources/syncify.local.library.rst.txt b/_build/_sources/syncify.local.library.rst.txt
diff --git a/_build/_sources/syncify.local.playlist.rst.txt b/_build/_sources/syncify.local.playlist.rst.txt
diff --git a/_build/_sources/syncify.local.rst.txt b/_build/_sources/syncify.local.rst.txt
diff --git a/_build/_sources/syncify.local.track.rst.txt b/_build/_sources/syncify.local.track.rst.txt
diff --git a/_build/_sources/syncify.processors.rst.txt b/_build/_sources/syncify.processors.rst.txt
diff --git a/_build/_sources/syncify.remote.processors.rst.txt b/_build/_sources/syncify.remote.processors.rst.txt