add reference rst + remove apidoc refresh on docs build

geo-martino · Sep 11, 2024 · e6b2da0 · e6b2da0
1 parent 9e2c03a
commit e6b2da0
Show file tree

Hide file tree

Showing 78 changed files with 936 additions and 3 deletions.
diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml
@@ -43,7 +43,8 @@ jobs:
 
       - name: 🏗️ Sphinx build
         run: |
-          make rebuild-html
+          make html
+          make linkcheck
 
       - name: 📦 Upload build artifacts
         uses: actions/upload-pages-artifact@v3

diff --git a/.gitignore b/.gitignore
@@ -140,7 +140,7 @@ _logs/
 
 # Sphinx/other documentation
 docs/_build/
-docs/reference/musify*.rst
+docs/reference/musify.rst
 .grip/
 
 # Jekyll

diff --git a/Makefile b/Makefile
@@ -15,10 +15,14 @@ LINKCHECKDIR  = docs/_linkcheck
 help:
 	$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+linkcheck: Makefile
+	@$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
 rebuild-html: Makefile
 	@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@rm -f "$(SOURCEDIR)"/reference/"$(PROJECTNAME)"*.rst
-	@sphinx-apidoc -o "$(SOURCEDIR)"/reference ./"$(PROJECTNAME)" -d 4 --force --module-first --separate --no-toc -t "$(SOURCEDIR)"/_templates
+	@sphinx-apidoc -o "$(SOURCEDIR)"/reference ./"$(PROJECTNAME)" -d 4 --force \
+	  --module-first --separate --no-toc -t "$(SOURCEDIR)"/_templates
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 

diff --git a/docs/reference/musify.base.rst b/docs/reference/musify.base.rst
@@ -0,0 +1,11 @@
+Base
+====
+
+.. inheritance-diagram:: musify.base
+   :parts: 1
+
+.. automodule:: musify.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.exception.rst b/docs/reference/musify.exception.rst
@@ -0,0 +1,11 @@
+Exceptions
+==========
+
+.. inheritance-diagram:: musify.exception
+   :parts: 1
+
+.. automodule:: musify.exception
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.field.rst b/docs/reference/musify.field.rst
@@ -0,0 +1,11 @@
+Field
+=====
+
+.. inheritance-diagram:: musify.field
+   :parts: 1
+
+.. automodule:: musify.field
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.file.base.rst b/docs/reference/musify.file.base.rst
@@ -0,0 +1,11 @@
+Base
+====
+
+.. inheritance-diagram:: musify.file.base
+   :parts: 1
+
+.. automodule:: musify.file.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.file.exception.rst b/docs/reference/musify.file.exception.rst
@@ -0,0 +1,11 @@
+Exceptions
+==========
+
+.. inheritance-diagram:: musify.file.exception
+   :parts: 1
+
+.. automodule:: musify.file.exception
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.file.image.rst b/docs/reference/musify.file.image.rst
@@ -0,0 +1,11 @@
+Image
+=====
+
+.. inheritance-diagram:: musify.file.image
+   :parts: 1
+
+.. automodule:: musify.file.image
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.file.path_mapper.rst b/docs/reference/musify.file.path_mapper.rst
@@ -0,0 +1,11 @@
+Path Mapper
+===========
+
+.. inheritance-diagram:: musify.file.path_mapper
+   :parts: 1
+
+.. automodule:: musify.file.path_mapper
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.file.rst b/docs/reference/musify.file.rst
@@ -0,0 +1,17 @@
+File
+====
+
+.. automodule:: musify.file
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Submodules:
+
+   musify.file.base
+   musify.file.exception
+   musify.file.image
+   musify.file.path_mapper
+
diff --git a/docs/reference/musify.libraries.collection.rst b/docs/reference/musify.libraries.collection.rst
@@ -0,0 +1,11 @@
+Collection
+==========
+
+.. inheritance-diagram:: musify.libraries.collection
+   :parts: 1
+
+.. automodule:: musify.libraries.collection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.core.collection.rst b/docs/reference/musify.libraries.core.collection.rst
@@ -0,0 +1,11 @@
+Collection
+==========
+
+.. inheritance-diagram:: musify.libraries.core.collection
+   :parts: 1
+
+.. automodule:: musify.libraries.core.collection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.core.object.rst b/docs/reference/musify.libraries.core.object.rst
@@ -0,0 +1,11 @@
+Object
+======
+
+.. inheritance-diagram:: musify.libraries.core.object
+   :parts: 1
+
+.. automodule:: musify.libraries.core.object
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.core.rst b/docs/reference/musify.libraries.core.rst
@@ -0,0 +1,15 @@
+Core
+====
+
+.. automodule:: musify.libraries.core
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Submodules:
+
+   musify.libraries.core.collection
+   musify.libraries.core.object
+
diff --git a/docs/reference/musify.libraries.local.base.rst b/docs/reference/musify.libraries.local.base.rst
@@ -0,0 +1,11 @@
+Base
+====
+
+.. inheritance-diagram:: musify.libraries.local.base
+   :parts: 1
+
+.. automodule:: musify.libraries.local.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.collection.rst b/docs/reference/musify.libraries.local.collection.rst
@@ -0,0 +1,11 @@
+Collection
+==========
+
+.. inheritance-diagram:: musify.libraries.local.collection
+   :parts: 1
+
+.. automodule:: musify.libraries.local.collection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.exception.rst b/docs/reference/musify.libraries.local.exception.rst
@@ -0,0 +1,11 @@
+Exceptions
+==========
+
+.. inheritance-diagram:: musify.libraries.local.exception
+   :parts: 1
+
+.. automodule:: musify.libraries.local.exception
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.library.library.rst b/docs/reference/musify.libraries.local.library.library.rst
@@ -0,0 +1,11 @@
+Library
+=======
+
+.. inheritance-diagram:: musify.libraries.local.library.library
+   :parts: 1
+
+.. automodule:: musify.libraries.local.library.library
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.library.musicbee.rst b/docs/reference/musify.libraries.local.library.musicbee.rst
@@ -0,0 +1,11 @@
+Musicbee
+========
+
+.. inheritance-diagram:: musify.libraries.local.library.musicbee
+   :parts: 1
+
+.. automodule:: musify.libraries.local.library.musicbee
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.library.rst b/docs/reference/musify.libraries.local.library.rst
@@ -0,0 +1,15 @@
+Library
+=======
+
+.. automodule:: musify.libraries.local.library
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Submodules:
+
+   musify.libraries.local.library.library
+   musify.libraries.local.library.musicbee
+
diff --git a/docs/reference/musify.libraries.local.playlist.base.rst b/docs/reference/musify.libraries.local.playlist.base.rst
@@ -0,0 +1,11 @@
+Base
+====
+
+.. inheritance-diagram:: musify.libraries.local.playlist.base
+   :parts: 1
+
+.. automodule:: musify.libraries.local.playlist.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.playlist.m3u.rst b/docs/reference/musify.libraries.local.playlist.m3u.rst
@@ -0,0 +1,11 @@
+M3U
+===
+
+.. inheritance-diagram:: musify.libraries.local.playlist.m3u
+   :parts: 1
+
+.. automodule:: musify.libraries.local.playlist.m3u
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.playlist.rst b/docs/reference/musify.libraries.local.playlist.rst
@@ -0,0 +1,17 @@
+Playlist
+========
+
+.. automodule:: musify.libraries.local.playlist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Submodules:
+
+   musify.libraries.local.playlist.base
+   musify.libraries.local.playlist.m3u
+   musify.libraries.local.playlist.utils
+   musify.libraries.local.playlist.xautopf
+
diff --git a/docs/reference/musify.libraries.local.playlist.utils.rst b/docs/reference/musify.libraries.local.playlist.utils.rst
@@ -0,0 +1,11 @@
+Utils
+=====
+
+.. inheritance-diagram:: musify.libraries.local.playlist.utils
+   :parts: 1
+
+.. automodule:: musify.libraries.local.playlist.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.playlist.xautopf.rst b/docs/reference/musify.libraries.local.playlist.xautopf.rst
@@ -0,0 +1,11 @@
+XAUTOPF
+=======
+
+.. inheritance-diagram:: musify.libraries.local.playlist.xautopf
+   :parts: 1
+
+.. automodule:: musify.libraries.local.playlist.xautopf
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/reference/musify.libraries.local.rst b/docs/reference/musify.libraries.local.rst
@@ -0,0 +1,24 @@
+Local
+=====
+
+.. automodule:: musify.libraries.local
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Subpackages:
+
+   musify.libraries.local.library
+   musify.libraries.local.playlist
+   musify.libraries.local.track
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Submodules:
+
+   musify.libraries.local.base
+   musify.libraries.local.collection
+   musify.libraries.local.exception
+
diff --git a/docs/reference/musify.libraries.local.track.field.rst b/docs/reference/musify.libraries.local.track.field.rst
@@ -0,0 +1,11 @@
+Field
+=====
+
+.. inheritance-diagram:: musify.libraries.local.track.field
+   :parts: 1
+
+.. automodule:: musify.libraries.local.track.field
+    :members:
+    :undoc-members:
+    :show-inheritance:
+