github
/
InternLM
mirror of https://github.com/InternLM/InternLM
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(doc/code-docs): autodoc shown error (#265) 

* feat(code-docs): test auto doc

* feat(code-docs): test auto doc

* feat(code-docs): test auto doc

* feat(code-docs): test auto doc
pull/274/head
huangting4201 2023-09-04 10:20:06 +08:00 committed by GitHub
parent ad0cddce66
commit 3d091c302d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/code-docs/requirements.txt
View File

@ -5,3 +5,6 @@ sphinx_rtd_theme
sphinx_markdown_tables sphinx_markdown_tables
autodoc_pydantic==1.9 autodoc_pydantic==1.9
enum_tools enum_tools
numpy
torch
tqdm

33
doc/code-docs/source/conf.py
View File

@ -42,6 +42,22 @@ autodoc_pydantic_model_summary_list_order = "bysource"
autodoc_pydantic_model_member_order = "bysource" autodoc_pydantic_model_member_order = "bysource"
autodoc_pydantic_field_list_validators = False autodoc_pydantic_field_list_validators = False
# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
napoleon_preprocess_types = False
napoleon_type_aliases = None
napoleon_attr_annotations = True
templates_path = ["_templates"] templates_path = ["_templates"]
exclude_patterns = [] exclude_patterns = []
@ -52,11 +68,24 @@ exclude_patterns = []
html_theme = "sphinx_rtd_theme" html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"] html_static_path = ["_static"]
# GitHub integration
html_context = {
"display_github": True,
"github_user": "pjlab",
"github_repo": "InternLM",
"github_version": "master",
"conf_py_path": "/doc/code-docs/source/",
}
sys.path.insert(0, os.path.abspath("../../../")) sys.path.insert(0, os.path.abspath("../../../"))
# Prepend module names to class descriptions # Prepend module names to class descriptions
add_module_names = True add_module_names = True
autoclass_content = "init" autoclass_content = "class"
autodoc_mock_imports = ["apex", "torch"] autodoc_mock_imports = [
"apex",
"torch",
"numpy",
]