new library

docs/conf.py

@@ -0,0 +1,47 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..')) # or "../../src
+# 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 = 'FLAI'
+copyright = '2023, Rubén González'
+author = 'Rubén González'
+release = '1.0.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",  # automatically generate documentation for modules
+    "sphinx.ext.napoleon",  # to read Google-style or Numpy-style docstrings
+    "sphinx.ext.viewcode",  # to allow vieing the source code in the web page
+    "autodocsumm",  # to generate tables of functions, attributes, methods, etc.
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+# don't include docstrings from the parent class
+autodoc_inherit_docstrings = False
+# Show types only in descriptions, not in signatures
+autodoc_typehints = "description"
+
+# -- 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']
+
+def skip(app, what, name, obj, would_skip, options):
+    if name == "__init__":
+        return False
+    return would_skip
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip)

docs/index.rst

@@ -0,0 +1,20 @@
+.. FLAI documentation master file, created by
+   sphinx-quickstart on Sat Jun  3 18:11:14 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to FLAI's documentation!
+================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`