Sphinx docs using AutoAPI (#19)

* Sphinx docs using AutoAPI

* Add create documentation workflow

---------

Co-authored-by: MasloMaslane <[email protected]>

Author: geoff128

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Create documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Install pip dependencies
+        run: |
+          pip install -e .[docs]
+      - name: Run Sphinx
+        run: |
+          cd docs
+          make html
+      - name: Upload HTML artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -16,4 +16,7 @@ coverage.xml
 .DS_Store
 
 # Files from Django db
-/sio3pack
+/sio3pack
+
+# Sphinx documentation
+docs/_build/

docs/Makefile

@@ -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)

docs/conf.py

@@ -0,0 +1,73 @@
+# 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
+
+import sio3pack
+
+project = 'SIO3Pack'
+copyright = '2025, Tomasz Kwiatkowski, Mateusz Masiarz, Jakub Rożek, Stanisław Struzik'
+author = 'Tomasz Kwiatkowski, Mateusz Masiarz, Jakub Rożek, Stanisław Struzik'
+release = sio3pack.__version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'autoapi.extension',
+    'sphinx.ext.autodoc',  # Also required by AutoAPI.
+    'sphinx.ext.viewcode',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "special-members",
+    "imported-members",
+]
+autoapi_dirs = ['../src/sio3pack/']
+# Additional objects to include.
+autoapi_include = [
+    "sio3pack.django.common.handler.DjangoHandler",
+    "sio3pack.django.sinolpack.handler.SinolpackDjangoHandler",
+]
+autodoc_typehints = 'description'
+
+def should_skip_submodule(app, what, name, obj, skip, options):
+    if what == "module":
+        skip = True
+    if what == "attribute":
+        skip = True
+
+    for object in autoapi_include:
+        # Include everything from object.
+        if name.startswith(object):
+            skip = False
+        # Include every parent modules.
+        if object.startswith(name):
+            skip = False
+
+    submodule = name.split(".")[-1]
+    # Don't show private objects.
+    if submodule.startswith("_"):
+        skip = True
+    # Skip django migrations.
+    if submodule in ["migrations"]:
+        skip = True
+    return skip
+
+def setup(sphinx):
+    sphinx.connect("autoapi-skip-member", should_skip_submodule)
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,10 @@
+.. SIO3Pack documentation master file.
+
+SIO3Pack documentation
+======================
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+

setup.cfg

@@ -40,6 +40,10 @@ django =
 vis =
     dash
     dash-cytoscape
+docs =
+    sphinx
+    sphinx-autoapi
+    furo
 
 [options.entry_points]
 console_scripts =

src/sio3pack/__init__.py

@@ -1,13 +1,16 @@
 __version__ = "1.0.0.dev1"
 
 from sio3pack.files import LocalFile
-from sio3pack.packages.exceptions import ImproperlyConfigured, PackageAlreadyExists
+from sio3pack.packages.exceptions import *
 from sio3pack.packages.package import Package
 
+__all__ = ["from_file", "from_db"]
+
 
 def from_file(file: str | LocalFile, django_settings=None) -> Package:
     """
     Initialize a package object from a file (archive or directory).
+
     :param file: The file path or File object.
     :param django_settings: Django settings object.
     :return: The package object.
@@ -22,6 +25,7 @@ def from_db(problem_id: int) -> Package:
     Initialize a package object from the database.
     If sio3pack isn't installed with Django support, it should raise an ImproperlyConfigured exception.
     If there is no package with the given problem_id, it should raise an UnknownPackageType exception.
+
     :param problem_id: The problem id.
     :return: The package object.
     """

src/sio3pack/django/common/handler.py

@@ -3,14 +3,27 @@
 from django.core.files import File
 from django.db import transaction
 
+import sio3pack
 from sio3pack.django.common.models import SIO3Package, SIO3PackModelSolution, SIO3PackNameTranslation, SIO3PackStatement
-from sio3pack.files.local_file import LocalFile
-from sio3pack.files.remote_file import RemoteFile
+from sio3pack.files import LocalFile, RemoteFile
 from sio3pack.packages.exceptions import ImproperlyConfigured, PackageAlreadyExists
 
 
 class DjangoHandler:
-    def __init__(self, package: Type["Package"], problem_id: int):
+    """
+    Base class for handling Django models.
+    Allows to save the package to the database and retrieve its data.
+
+    :param sio3pack.Package package: The package to handle.
+    :param int problem_id: The problem ID.
+    """
+
+    def __init__(self, package: "sio3pack.Package", problem_id: int):
+        """
+        Initialize the handler with the package and problem ID.
+        :param sio3pack.Package package: The package to handle.
+        :param int problem_id: The problem ID.
+        """
         self.package = package
         self.problem_id = problem_id
         try:
@@ -71,20 +84,37 @@ def _add_statement(language: str, statement: LocalFile):
 
     @property
     def short_name(self) -> str:
+        """
+        Short name of the problem.
+        """
         return self.db_package.short_name
 
     @property
     def full_name(self) -> str:
+        """
+        Full name of the problem.
+        """
         return self.db_package.full_name
 
     @property
     def lang_titles(self) -> dict[str, str]:
+        """
+        A dictionary of problem titles,
+        where keys are language codes and values are titles.
+        """
         return {t.language: t.name for t in self.db_package.name_translations.all()}
 
     @property
     def model_solutions(self) -> list[dict[str, Any]]:
+        """
+        A list of model solutions, where each element is a dictionary containing
+        a :class:`sio3pack.RemoteFile` object.
+        """
         return [{"file": RemoteFile(s.source_file.path)} for s in self.db_package.model_solutions.all()]
 
     @property
     def lang_statements(self) -> dict[str, RemoteFile]:
+        """
+        A dictionary of problem statements, where keys are language codes and values are files.
+        """
         return {s.language: RemoteFile(s.content.path) for s in self.db_package.statements.all()}

src/sio3pack/django/sinolpack/handler.py

@@ -11,13 +11,17 @@
     SinolpackConfig,
     SinolpackModelSolution,
 )
-from sio3pack.files.remote_file import RemoteFile
+from sio3pack.files import RemoteFile
 from sio3pack.packages.sinolpack.enums import ModelSolutionKind
 
 
 class SinolpackDjangoHandler(DjangoHandler):
+    """
+    Handler for Sinolpack packages in Django.
+    Has additional properties like config, model_solutions, additional_files and attachments.
+    """
 
-    def __init__(self, package: Type["Package"], problem_id: int):
+    def __init__(self, package: "sio3pack.Sinolpack", problem_id: int):
         super().__init__(package, problem_id)
 
     @transaction.atomic
@@ -69,17 +73,30 @@ def _save_attachments(self):
 
     @property
     def config(self) -> dict[str, Any]:
+        """
+        Config file of the package.
+        """
         return self.db_package.config.parsed_config
 
     @property
     def model_solutions(self) -> list[dict[str, Any]]:
+        """
+        A list of model solutions, where each element is a dictionary containing a :class:`sio3pack.RemoteFile` object
+        and the :class:`sio3pack.packages.sinolpack.enums.ModelSolutionKind` kind.
+        """
         solutions = SinolpackModelSolution.objects.filter(package=self.db_package)
         return [{"file": RemoteFile(s.source_file.path), "kind": s.kind} for s in solutions]
 
     @property
     def additional_files(self) -> list[RemoteFile]:
+        """
+        A list of additional files (as :class:`sio3pack.RemoteFile`) for the problem.
+        """
         return [RemoteFile(f.file.path) for f in self.db_package.additional_files.all()]
 
     @property
     def attachments(self) -> list[RemoteFile]:
+        """
+        A list of attachments (as :class:`sio3pack.RemoteFile`) related to the problem.
+        """
         return [RemoteFile(f.content.path) for f in self.db_package.attachments.all()]

src/sio3pack/files/file.py

@@ -1,6 +1,8 @@
 class File:
     """
     Base class for all files in a package.
+
+    :param str path: The path to the file.
     """
 
     def __init__(self, path: str):
@@ -10,7 +12,17 @@ def __str__(self):
         return f"<{self.__class__.__name__} {self.path}>"
 
     def read(self) -> str:
+        """
+        Read the file content.
+
+        :return: The content of the file.
+        """
         raise NotImplementedError()
 
     def write(self, text: str):
+        """
+        Write to the file.
+
+        :param str text: The text to write.
+        """
         raise NotImplementedError()

src/sio3pack/files/local_file.py

@@ -5,17 +5,19 @@
 
 class LocalFile(File):
     """
-    Base class for all files in a package that are stored locally.
+    Base class for a file in a package that is stored locally.
     """
 
     @classmethod
     def get_file_matching_extension(cls, dir: str, filename: str, extensions: list[str]) -> "LocalFile":
         """
         Get the file with the given filename and one of the given extensions.
-        :param dir: The directory to search in.
-        :param filename: The filename.
-        :param extensions: The extensions.
-        :return: The file object.
+
+        :param str dir: The directory to search in.
+        :param str filename: The filename.
+        :param list[str] extensions: The extensions.
+        :return LocalFile: The file object.
+        :raises FileNotFoundError: If no file is found.
         """
         for ext in extensions:
             path = os.path.join(dir, filename + "." + ext)
@@ -24,6 +26,11 @@ def get_file_matching_extension(cls, dir: str, filename: str, extensions: list[s
         raise FileNotFoundError
 
     def __init__(self, path: str):
+        """
+        Initialize the file.
+        :param str path: The path to the file.
+        :raises FileNotFoundError: If the file doesn't exist.
+        """
         if not os.path.exists(path):
             raise FileNotFoundError
         super().__init__(path)

src/sio3pack/files/remote_file.py

@@ -3,7 +3,7 @@
 
 class RemoteFile(File):
     """
-    Base class for all files in a package that are tracked by filetracker.
+    Base class for a file that is tracked by filetracker.
     """
 
     def __init__(self, path: str):