sphinx docs generator

Author: mithmith

app/db/repository.py

@@ -62,11 +62,7 @@ def add_channel(self, channel_data: ChannelInfoSchema) -> Channel:
         self.commit()
         return channel
 
-    def add_video(
-        self,
-        video_schema: VideoSchema,
-        channel_id: str
-    ) -> Video:
+    def add_video(self, video_schema: VideoSchema, channel_id: str) -> Video:
         """
         Adds a new video or updates an existing one based on the provided video schema.
 
@@ -511,9 +507,7 @@ def update_channel_details(self, channel_info: ChannelAPIInfoSchema) -> None:
         channel: Channel = self._session.query(Channel).filter_by(channel_id=channel_info.id).first()
 
         # Convert ChannelAPIInfoSchema to dictionary, excluding unset values
-        channel_dict = channel_info.model_dump(
-            exclude_unset=True
-        )
+        channel_dict = channel_info.model_dump(exclude_unset=True)
 
         if channel:
             # If the channel exists, update its attributes

app/integrations/__init__.py

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

app/service/__init__.py

@@ -0,0 +1,29 @@
+app.db package
+==============
+
+Submodules
+----------
+
+app.db.base module
+------------------
+
+.. automodule:: app.db.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+app.db.repository module
+------------------------
+
+.. automodule:: app.db.repository
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: app.db
+   :members:
+   :undoc-members:
+   :show-inheritance:

sphinx/Makefile

@@ -0,0 +1,29 @@
+app.integrations package
+========================
+
+Submodules
+----------
+
+app.integrations.ytapi module
+-----------------------------
+
+.. automodule:: app.integrations.ytapi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+app.integrations.ytdlp module
+-----------------------------
+
+.. automodule:: app.integrations.ytdlp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: app.integrations
+   :members:
+   :undoc-members:
+   :show-inheritance:

sphinx/app.db.rst

@@ -0,0 +1,47 @@
+app package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 1
+
+   app.db
+   app.integrations
+   app.service
+
+Submodules
+----------
+
+app.config module
+-----------------
+
+.. automodule:: app.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+app.const module
+----------------
+
+.. automodule:: app.const
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+app.schema module
+-----------------
+
+.. automodule:: app.schema
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: app
+   :members:
+   :undoc-members:
+   :show-inheritance:

sphinx/app.integrations.rst

@@ -0,0 +1,21 @@
+app.service package
+===================
+
+Submodules
+----------
+
+app.service.yt\_monitor module
+------------------------------
+
+.. automodule:: app.service.yt_monitor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: app.service
+   :members:
+   :undoc-members:
+   :show-inheritance:

sphinx/app.rst

@@ -0,0 +1,45 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+import app.db.data_table
+import app.db.repository
+import app.integrations.ytapi
+import app.integrations.ytdlp
+import app.service.yt_monitor
+
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Youtube node downloader'
+copyright = '2024, mithmith'
+author = 'mithmith'
+release = '0.0.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+extensions = [
+    'sphinx.ext.autodoc',  # Includes documentation from docstrings
+    'sphinx.ext.coverage',  # Checks documentation coverage
+    'sphinx.ext.napoleon',  # Support for Google and NumPy style docstrings
+    'sphinx.ext.viewcode',  # Adds links to the source code of documented Python objects
+]

sphinx/app.service.rst

@@ -0,0 +1,21 @@
+.. Youtube node downloader documentation master file, created by
+   sphinx-quickstart on Mon Apr 15 16:32:40 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Youtube node downloader's documentation!
+===================================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   app
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`