Harrison/more documentation (#19)

This commit is contained in:
Harrison Chase
2022-10-24 20:24:15 -07:00
committed by GitHub
parent 1ef3ab4d0e
commit 5621ca7b07
15 changed files with 330 additions and 55 deletions

View File

@@ -37,10 +37,19 @@ extensions = [
"sphinx.ext.autodoc.typehints",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinxcontrib.autodoc_pydantic",
]
autodoc_pydantic_model_show_json = False
autodoc_pydantic_field_list_validators = False
autodoc_pydantic_config_members = False
autodoc_pydantic_model_show_config_summary = False
autodoc_pydantic_model_show_validator_members = False
autodoc_pydantic_model_show_field_summary = False
autodoc_pydantic_model_members = False
autodoc_pydantic_model_undoc_members = False
# autodoc_typehints = "signature"
autodoc_typehints = "description"
# autodoc_typehints = "description"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
@@ -62,4 +71,4 @@ html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_static_path: list = []

View File

@@ -3,4 +3,4 @@
.. automodule:: langchain.llms
:members:
:undoc-members:
:special-members: __call__

View File

@@ -3,4 +3,3 @@
.. automodule:: langchain.prompt
:members:
:undoc-members:

View File

@@ -2,3 +2,4 @@ sphinx==4.5.0
sphinx-autobuild==2021.3.14
sphinx_rtd_theme==1.0.0
sphinx-typlog-theme==0.8.0
autodoc_pydantic==1.8.0