more

.github/workflows/api_doc_build.yml

@@ -127,6 +127,13 @@ jobs:
           python docs/api_reference/create_api_rst.py
 
           # Build the HTML documentation using Sphinx
+          # -T: show full traceback on exception
+          # -E: don't use cached environment (force rebuild, ignore cached doctrees)
+          # -b html: build HTML docs (vs PDS, etc.)
+          # -d: path for the cached environment (parsed document trees / doctrees)
+          #     - Separate from output dir for faster incremental builds
+          # -c: path to conf.py
+          # -j auto: parallel build using all available CPU cores
           python -m sphinx -T -E -b html -d ../langchain-api-docs-html/_build/doctrees -c docs/api_reference docs/api_reference ../langchain-api-docs-html/api_reference_build/html -j auto
 
           # Post-process the generated HTML

docs/README.md

@@ -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.

docs/api_reference/scripts/custom_formatter.py

@@ -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