Skip to content

Commit

Permalink
update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Alleria1809 committed May 29, 2024
1 parent 0e7195e commit cce2395
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
5 changes: 0 additions & 5 deletions docs/source/apis/components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,4 @@ Retrievers
:maxdepth: 1

components.retriever
9 changes: 0 additions & 9 deletions9
docs/source/apis/components/modules.rst
This file was deleted.

9 changes: 0 additions & 9 deletions9
docs/source/apis/core/core.api_client.rst
8 changes: 6 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,18 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]


# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = "LightRAG"
# this will be the logo shown on the browser header
html_favicon = "../../images/LightRAG-logo.jpg"

# In Sphinx documentation, the configuration option add_module_names in the conf.py file controls
# whether module names are prefixed before object names in the documentation. This setting is particularly
# relevant when documenting Python modules and their contents, such as classes, functions, and methods.
autosummary_generate = True # Tells Sphinx to generate summary pages
add_module_names = False
autosectionlabel_prefix_document = True
autodoc_docstring_signature = True
autosummary_generate = True # Tells Sphinx to generate summary pages


# autodoc_default_options = {
Expand All @@ -121,6 +124,7 @@
"show-inheritance": True,
"private-members": False, # Ensure this is True if you want to document private members
"special-members": "__init__", # Document special members like __init__
'inherited-members': True,
# "autosectionlabel_prefix_document": True,
}

Expand Down

0 comments on commit cce2395

Please sign in to comment.