summaryrefslogtreecommitdiff
path: root/venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py
diff options
context:
space:
mode:
authorcyfraeviolae <cyfraeviolae>2024-04-03 03:10:44 -0400
committercyfraeviolae <cyfraeviolae>2024-04-03 03:10:44 -0400
commit6d7ba58f880be618ade07f8ea080fe8c4bf8a896 (patch)
treeb1c931051ffcebd2bd9d61d98d6233ffa289bbce /venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py
parent4f884c9abc32990b4061a1bb6997b4b37e58ea0b (diff)
venv
Diffstat (limited to 'venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py')
-rw-r--r--venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py19
1 files changed, 19 insertions, 0 deletions
diff --git a/venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py b/venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py
new file mode 100644
index 0000000..8e7154e
--- /dev/null
+++ b/venv/lib/python3.11/site-packages/faker/sphinx/autodoc.py
@@ -0,0 +1,19 @@
+# coding=utf-8
+from faker.sphinx.docstring import ProviderMethodDocstring
+from faker.sphinx.documentor import write_provider_docs
+
+
+def _create_source_files(app):
+ write_provider_docs()
+
+
+def _process_docstring(app, what, name, obj, options, lines):
+ docstring = ProviderMethodDocstring(app, what, name, obj, options, lines)
+ if not docstring.skipped:
+ lines[:] = docstring.lines[:]
+
+
+def setup(app):
+ app.setup_extension("sphinx.ext.autodoc")
+ app.connect("builder-inited", _create_source_files)
+ app.connect("autodoc-process-docstring", _process_docstring)