From dc31a8bd80b47f608b37333fb09aebbfb1c81000 Mon Sep 17 00:00:00 2001 From: AlessioNar Date: Mon, 23 Dec 2024 16:23:12 +0100 Subject: [PATCH] Testing automated documentation --- docs/source/conf.py | 6 ++++++ docs/source/index.rst | 6 +++--- docs/source/{api => parsers}/modules.rst | 2 +- 3 files changed, 10 insertions(+), 4 deletions(-) rename docs/source/{api => parsers}/modules.rst (93%) diff --git a/docs/source/conf.py b/docs/source/conf.py index f780ef6..8d3b205 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,5 +1,8 @@ # Configuration file for the Sphinx documentation builder. +import os +import sys + # -- Project information project = 'tulit' @@ -9,6 +12,7 @@ version = '0.0.3' # -- General configuration +sys.path.insert(0, os.path.abspath('../tulit')) extensions = [ 'sphinx.ext.duration', @@ -16,6 +20,8 @@ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + ] intersphinx_mapping = { diff --git a/docs/source/index.rst b/docs/source/index.rst index 52ae6ee..8c7f04e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,11 +22,11 @@ Contents usage api -API Documentation +Parsers ----------------- .. toctree:: :maxdepth: 2 - :caption: API Reference: + :caption: Parsers: - api/modules \ No newline at end of file + parsers/modules \ No newline at end of file diff --git a/docs/source/api/modules.rst b/docs/source/parsers/modules.rst similarity index 93% rename from docs/source/api/modules.rst rename to docs/source/parsers/modules.rst index 2a819cc..c60b258 100644 --- a/docs/source/api/modules.rst +++ b/docs/source/parsers/modules.rst @@ -1,4 +1,4 @@ -API Reference +Parsers ============= .. automodule:: tulit.parsers.akomantoso