This commit is contained in:
Mason Daugherty
2025-09-23 15:30:29 -04:00
parent e20353f9e5
commit c2ca64fac3
3 changed files with 23 additions and 1 deletions

View File

@@ -1,3 +1,11 @@
# LangChain Documentation
For more information on contributing to our documentation, see the [Documentation Contributing Guide](https://python.langchain.com/docs/contributing/how_to/documentation)
For more information on contributing to our documentation, see the [Documentation Contributing Guide](https://python.langchain.com/docs/contributing/how_to/documentation).
## Structure
The primary documentation is located in the `docs/` directory and has a different build process than the API reference docs.
API reference documentation is located in `docs/api_reference/` and is automatically generated from the codebase using Sphinx.
The API reference docs are built and deployed separately from the main documentation. See the `README.md` in the `docs/api_reference/`
directory for more details on how to build and contribute to the API reference docs.

View File

@@ -1,3 +1,10 @@
"""Post-process generated HTML files to clean up table-of-contents headers.
Runs after Sphinx generates the API reference HTML. It finds TOC entries like
"ClassName.method_name()" and shortens them to just "method_name()" for better
readability in the sidebar navigation.
"""
import sys
from glob import glob
from pathlib import Path