Added sphinx-autoapi. Fixed some documentation.

.gitignore

@@ -71,6 +71,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/build/
 
 # PyBuilder
 .pybuilder/

doc/conf.py

@@ -8,8 +8,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'installation-instruction'
-copyright = '2024, Adam McKellar'
-author = 'Adam McKellar'
+copyright = '2024, Adam McKellar, Kanushka Gupta, Timo Ege'
+author = 'Adam McKellar, Kanushka Gupta, Timo Ege'
 
 # -- General configuration ---------------------------------------------------
 
@@ -20,8 +20,11 @@
     "sphinx_mdinclude",
     "sphinx.ext.autodoc",
     "sphinx_rtd_theme",
+    "autoapi.extension",
 ]
 
+autoapi_dirs = ['../installation_instruction']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
 

doc/index.rst

@@ -6,7 +6,6 @@ installation-instruction
    :caption: Contents:
 
    intro
-   api
 
 Indices and tables
 ==================

installation_instruction/__init__.py

@@ -19,4 +19,5 @@
 del metadata
 
 from installation_instruction.installation_instruction import InstallationInstruction
+import installation_instruction.helpers
 

installation_instruction/installation_instruction.py

@@ -40,7 +40,7 @@ def validate_and_render(self, input: dict) -> tuple[str, bool]:
         :ptype input: dict
         :return: Returns instructions as string and False. Or Error and True.
         :rtpye: (str, bool)
-        :raise Exception: If no delimiter is found.
+        :raise Exception: If schema or user input is invalid.
         """
         validate(input, self.schema)
         instruction = self.template.render(input)
@@ -55,8 +55,11 @@ def validate_and_render(self, input: dict) -> tuple[str, bool]:
 
     def __init__(self, config: str) -> None:
         """
-        :param config: Config file with schema and template seperated by ------ delimiter.
+        Returns `InstallationInstruction` from config string.
+
+        :param config: Config string with schema and template seperated by delimiter.
         :raise Exception: If schema part of config is neither valid json nor valid yaml.
+        :raise Exception: If no delimiter is found.
         """
         (schema, template) = helpers._split_string_at_delimiter(config)
         try:

pyproject.toml

@@ -42,6 +42,7 @@ docs = [
     "sphinx",
     "sphinx_mdinclude",
     "sphinx_rtd_theme",
+    "sphinx-autoapi",
 ]