attempt to publish docs 2

.github/workflows/documentation.yml

@@ -1,9 +1,24 @@
 name: documentation
 
-on: [push, pull_request, workflow_dispatch]
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["v0.3"]
 
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
   build:
@@ -24,8 +39,8 @@ jobs:
 
       - name: Sphinx build
         run: |
-          sphinx-apidoc -o doc src
-          sphinx-build doc .build        
+          sphinx-apidoc -o ./docs ./src
+          sphinx-build ./docs ./.build        
 
       - name: Jekyll build
         uses: actions/jekyll-build-pages@v1

doc/conf.py → docs/conf.py

@@ -14,7 +14,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc', 'sphinx_jekyll_builder']
+extensions = ['sphinx.ext.autodoc', 'sphinx_markdown_builder']
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

docs/modules.rst

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   syncify

docs/syncify.abstract.rst

@@ -0,0 +1,45 @@
+syncify.abstract package
+========================
+
+Submodules
+----------
+
+syncify.abstract.collection module
+----------------------------------
+
+.. automodule:: syncify.abstract.collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.abstract.enums module
+-----------------------------
+
+.. automodule:: syncify.abstract.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.abstract.misc module
+----------------------------
+
+.. automodule:: syncify.abstract.misc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.abstract.object module
+------------------------------
+
+.. automodule:: syncify.abstract.object
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.abstract
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.api.rst

@@ -0,0 +1,21 @@
+syncify.api package
+===================
+
+Submodules
+----------
+
+syncify.api.exception module
+----------------------------
+
+.. automodule:: syncify.api.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.local.library.rst

@@ -0,0 +1,10 @@
+syncify.local.library package
+=============================
+
+Module contents
+---------------
+
+.. automodule:: syncify.local.library
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.local.playlist.rst

@@ -0,0 +1,10 @@
+syncify.local.playlist package
+==============================
+
+Module contents
+---------------
+
+.. automodule:: syncify.local.playlist
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.local.rst

@@ -0,0 +1,39 @@
+syncify.local package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   syncify.local.library
+   syncify.local.playlist
+   syncify.local.track
+
+Submodules
+----------
+
+syncify.local.collection module
+-------------------------------
+
+.. automodule:: syncify.local.collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.local.exception module
+------------------------------
+
+.. automodule:: syncify.local.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.local
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.local.track.rst

@@ -0,0 +1,10 @@
+syncify.local.track package
+===========================
+
+Module contents
+---------------
+
+.. automodule:: syncify.local.track
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.processors.rst

@@ -0,0 +1,69 @@
+syncify.processors package
+==========================
+
+Submodules
+----------
+
+syncify.processors.base module
+------------------------------
+
+.. automodule:: syncify.processors.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.compare module
+---------------------------------
+
+.. automodule:: syncify.processors.compare
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.exception module
+-----------------------------------
+
+.. automodule:: syncify.processors.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.limit module
+-------------------------------
+
+.. automodule:: syncify.processors.limit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.match module
+-------------------------------
+
+.. automodule:: syncify.processors.match
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.sort module
+------------------------------
+
+.. automodule:: syncify.processors.sort
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.time module
+------------------------------
+
+.. automodule:: syncify.processors.time
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.processors
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.remote.processors.rst

@@ -0,0 +1,37 @@
+syncify.remote.processors package
+=================================
+
+Submodules
+----------
+
+syncify.remote.processors.check module
+--------------------------------------
+
+.. automodule:: syncify.remote.processors.check
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.processors.search module
+---------------------------------------
+
+.. automodule:: syncify.remote.processors.search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.processors.wrangle module
+----------------------------------------
+
+.. automodule:: syncify.remote.processors.wrangle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.remote.processors
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/syncify.remote.rst

@@ -0,0 +1,85 @@
+syncify.remote package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   syncify.remote.processors
+
+Submodules
+----------
+
+syncify.remote.api module
+-------------------------
+
+.. automodule:: syncify.remote.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.base module
+--------------------------
+
+.. automodule:: syncify.remote.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.config module
+----------------------------
+
+.. automodule:: syncify.remote.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.enums module
+---------------------------
+
+.. automodule:: syncify.remote.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.exception module
+-------------------------------
+
+.. automodule:: syncify.remote.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.library module
+-----------------------------
+
+.. automodule:: syncify.remote.library
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.object module
+----------------------------
+
+.. automodule:: syncify.remote.object
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.types module
+---------------------------
+
+.. automodule:: syncify.remote.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.remote
+   :members:
+   :undoc-members:
+   :show-inheritance: