added more docs

Author: pablomarcel

polynomial_equations/polynomialTool/cli.py

@@ -0,0 +1,6 @@
+# Minimal Sphinx Makefile
+.PHONY: html clean
+html:
+	+sphinx-build -b html . _build/html
+clean:
+	+rm -rf _build

polynomial_equations/polynomialTool/docs/Makefile

@@ -0,0 +1,59 @@
+API Reference
+=============
+
+polynomial_equations.polynomialTool.cli
+---------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+polynomial_equations.polynomialTool.apis
+----------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.apis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+polynomial_equations.polynomialTool.app
+---------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.app
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+polynomial_equations.polynomialTool.core
+----------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.core
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+polynomial_equations.polynomialTool.io
+--------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+polynomial_equations.polynomialTool.utils
+-----------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+polynomial_equations.polynomialTool.design
+------------------------------------------
+
+.. automodule:: polynomial_equations.polynomialTool.design
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

polynomial_equations/polynomialTool/docs/_static/.gitkeep

@@ -0,0 +1,28 @@
+# Generated by polynomial_equations.polynomialTool.cli
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+# docs -> polynomialTool -> polynomial_equations -> repository root
+ROOT = Path(__file__).resolve().parents[3]
+sys.path.insert(0, str(ROOT))
+
+project = 'Digital Control - polynomial_equations.polynomialTool'
+author = 'Digital Control'
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+html_theme = "furo"
+html_static_path = ["_static"]
+
+autodoc_typehints = "description"
+autodoc_mock_imports = ['control', 'matplotlib', 'matplotlib.pyplot', 'numpy', 'pandas', 'plotly', 'plotly.graph_objects', 'scipy', 'scipy.linalg', 'scipy.signal', 'sympy']
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True

polynomial_equations/polynomialTool/docs/_templates/.gitkeep

@@ -0,0 +1,10 @@
+.. polynomial_equations.polynomialTool documentation master file
+
+Welcome to polynomial_equations.polynomialTool's documentation
+==============================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api