feat: documentation generation

numerique-gouv · Dec 12, 2023 · 1d8317b · 1d8317b
1 parent e0a4971
commit 1d8317b
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 1 deletion.
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -20,6 +20,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "sphinxcontrib.autodoc_pydantic",
 ]
 
 templates_path = ["_templates"]
@@ -90,3 +91,13 @@
 # -- Options for autosectionlabel -----------------------------------------
 
 autosectionlabel_prefix_document = True
+
+# -- Options for autodo_pydantic_settings -------------------------------------------
+
+autodoc_pydantic_model_show_json = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_model_show_validator_summary = False
+autodoc_pydantic_model_show_validator_members = False
+autodoc_pydantic_model_show_field_summary = False
+autodoc_pydantic_field_list_validators = False
diff --git a/documentation/maintainers/index.rst b/documentation/maintainers/index.rst
@@ -7,4 +7,5 @@ Cette partie de la documentation est à destination des personnes qui déploient
    :maxdepth: 2
 
    pullRequestValidation
+   settings
    meetingFiles
diff --git a/documentation/maintainers/settings.rst b/documentation/maintainers/settings.rst
@@ -0,0 +1,4 @@
+Configuration
+#############
+
+.. autopydantic_model:: flaskr.settings.MainSettings
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -56,6 +56,7 @@ optional = true
 sphinx = "^7.0.0"
 sphinx-rtd-theme = "^2.0.0"
 sphinx-issues = "^3.0.0"
+autodoc-pydantic = "^2.0.1"
 myst-parser = "^2.0.0"
 
 [tool.black]

diff --git a/web/requirements.doc.txt b/web/requirements.doc.txt
@@ -1,4 +1,6 @@
 alabaster==0.7.13 ; python_full_version >= "3.8.1" and python_version < "4.0"
+annotated-types==0.6.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
+autodoc-pydantic==2.0.1 ; python_full_version >= "3.8.1" and python_version < "4.0"
 babel==2.13.1 ; python_full_version >= "3.8.1" and python_version < "4.0"
 certifi==2023.11.17 ; python_full_version >= "3.8.1" and python_version < "4.0"
 charset-normalizer==3.3.2 ; python_full_version >= "3.8.1" and python_version < "4.0"
@@ -14,7 +16,11 @@ mdit-py-plugins==0.4.0 ; python_full_version >= "3.8.1" and python_version < "4.
 mdurl==0.1.2 ; python_full_version >= "3.8.1" and python_version < "4.0"
 myst-parser==2.0.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
 packaging==23.2 ; python_full_version >= "3.8.1" and python_version < "4.0"
+pydantic-core==2.14.5 ; python_full_version >= "3.8.1" and python_version < "4.0"
+pydantic-settings==2.1.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
+pydantic==2.5.2 ; python_full_version >= "3.8.1" and python_version < "4.0"
 pygments==2.17.2 ; python_full_version >= "3.8.1" and python_version < "4.0"
+python-dotenv==1.0.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
 pytz==2023.3.post1 ; python_full_version >= "3.8.1" and python_version < "3.9"
 pyyaml==6.0.1 ; python_full_version >= "3.8.1" and python_version < "4.0"
 requests==2.31.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
@@ -30,5 +36,6 @@ sphinxcontrib-jquery==4.1 ; python_full_version >= "3.8.1" and python_version <
 sphinxcontrib-jsmath==1.0.1 ; python_full_version >= "3.8.1" and python_version < "4.0"
 sphinxcontrib-qthelp==1.0.3 ; python_full_version >= "3.8.1" and python_version < "4.0"
 sphinxcontrib-serializinghtml==1.1.5 ; python_full_version >= "3.8.1" and python_version < "4.0"
+typing-extensions==4.8.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
 urllib3==2.1.0 ; python_full_version >= "3.8.1" and python_version < "4.0"
 zipp==3.17.0 ; python_full_version >= "3.8.1" and python_version < "3.10"