Merge pull request #10 from d-SEAMS/pyseams_docs

Pyseams docs

Author: HaoZeke

docs/source/conf.py

@@ -11,28 +11,28 @@
 copyright = '2024, d-SEAMS developers'
 author = 'Ruhila'
 
+import pyseams
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 #referenced my favourite [1]
 extensions = [
     "myst_parser",
-    "autodoc2",
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
+    #"autodoc2",
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.githubpages",
     "sphinx_contributors",
     "sphinx_copybutton",
     "sphinx_design",
     "sphinxcontrib.spelling",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
 ]
+autosummary_generate = True
 
-autodoc2_render_plugin = "myst"
-autodoc2_packages = [
-    f"../../src/{project.lower()}",
-]
 
 myst_enable_extensions = [
     "deflist",
@@ -47,6 +47,11 @@
 templates_path = ['_templates']
 exclude_patterns = []
 
+# The suffix(es) of source filenames.
+source_suffix = [".rst", ".md"]
+
+# The master toctree document.
+master_doc = "index"
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -63,6 +68,7 @@
 }
 # --- Plugin options
 autodoc2_render_plugin = "myst"
+autodoc2_packages = [f"../../{project.lower()}"]
 
 
 #references

docs/source/index.md

@@ -27,18 +27,25 @@ cd pyseams
 
 
 
-## Additional Topics
+## documentation for pyseams-bindings 
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   api/library_root
+```{toctree}
+:maxdepth: 2
+:caption: Contents
 
+```
 
+```{eval-rst}
+.. automodule:: pyseams.cyoda
+```
 
+<!-- ```{autodoc2-summary}
+pyseams.cyoda
+```
 
+```{eval-rst}
 
+``` -->
 
 ## Indices and tables
 

meson.build

@@ -39,7 +39,7 @@ py.extension_module(
 
 # pyseams main package
 py.install_sources([
-    'pyseams/__init__.py',
+    'src/__init__.py',
   ],
   pure: false, # install next to compiled extension
   subdir: 'pyseams/'