From 8386b3c148588a0d0aae3e2916b87da91a7f23a4 Mon Sep 17 00:00:00 2001
From: Beartriz Recinos Rivas <brivas@NOCS05291F.lan>
Date: Mon, 21 Jun 2021 16:39:20 +0100
Subject: [PATCH] updated docs-sphinx config
---
.../lib/imma1_d701/code_tables/ICOADS.C99.FORM.json | 8 ++++----
docs/conf.py | 13 +++++++++++--
docs/requirements.txt | 1 +
3 files changed, 16 insertions(+), 6 deletions(-)
diff --git a/data_models/lib/imma1_d701/code_tables/ICOADS.C99.FORM.json b/data_models/lib/imma1_d701/code_tables/ICOADS.C99.FORM.json
index fc959fe..ca2d864 100644
--- a/data_models/lib/imma1_d701/code_tables/ICOADS.C99.FORM.json
+++ b/data_models/lib/imma1_d701/code_tables/ICOADS.C99.FORM.json
@@ -1,8 +1,8 @@
{
" 1": "daily",
" 2": "reports more than once a day",
- "1 ": "daily",
- "2 ": "reports more than once a day",
- "01": "daily",
- "02": "reports more than once a day"
+ "1 ": "daily",
+ "2 ": "reports more than once a day",
+ "01": "daily",
+ "02": "reports more than once a day"
}
diff --git a/docs/conf.py b/docs/conf.py
index 1494bf2..a0a8508 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,13 +30,22 @@ release = 'v1.3'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = []
+# extensions = []
+
+# extensions.append('autoapi.extension')
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.viewcode',
+ 'autoapi.extension',
+ 'sphinx.ext.napoleon',
+ 'sphinx_autodoc_typehints']
-extensions.append('autoapi.extension')
autoapi_type = 'python'
autoapi_dirs = ['../']
add_module_names = False
+autoapi_keep_files = False
+autodoc_typehints = "description"
#autoapi_options = ['members', 'undoc-members', 'private-members']
autoapi_options = ['members', 'undoc-members', 'private-members', 'show-inheritance',
diff --git a/docs/requirements.txt b/docs/requirements.txt
index b0c76db..a5746f6 100755
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -3,3 +3,4 @@
sphinx==3.5.4
sphinx-autoapi==1.8.0
sphinx-rtd-theme==0.5.2
+sphinx-autodoc-typehints
\ No newline at end of file
--
GitLab