This directory contains the documentation source code for LlamaIndex, available at https://docs.llamaindex.ai.
Sign in to like and favorite skills
This directory contains the documentation source code for LlamaIndex, available at https://docs.llamaindex.ai.
This guide is made for anyone who's interested in running LlamaIndex documentation locally, making changes to it and making contributions. LlamaIndex is made by the thriving community behind it, and you're always welcome to make contributions to the project and the documentation.
If you haven't already, clone the LlamaIndex Github repo to a local directory:
git clone https://github.com/run-llama/llama_index.git && cd llama_index
Documentation has its own, dedicated Python virtual environment, and all the tools and scripts are available from the
docscd llama_index/docs
From now on, we assume all the commands will be executed from the
docsInstall all dependencies required for building docs (mainly
mkdocspoetry installTo pull external docs:
poetry run python scripts/merge_external_docs.py
To build the docs and browse them locally run:
poetry run serve
During the build, notebooks are converted to documentation pages, and this takes several minutes. If you're not working on the "Examples" section of the documentation, you can run the same command with
--skip-notebookspoetry run serve --skip-notebooks
Another way to save build time is to skip generating the API reference:
poetry run serve --skip-reference
The two options can go together for a minimal build
poetry run serve --skip-notebooks --skip-reference
[!IMPORTANT] Building the documentation takes a while, so make sure you see the following output before opening the browser:
... INFO - Documentation built in 53.32 seconds INFO - [16:18:17] Watching paths for changes: 'docs' INFO - [16:18:17] Serving on http://127.0.0.1:8000/en/stable/
You can now open your browser at http://localhost:8000/ to view the generated docs. The local server will rebuild the docs and refresh your browser every time you make changes to the docs.
Part of the configuration in
mkdocs.ymlRunning the command
poetry run prepare-for-builddocsmkdocs.yml[!TIP] As a contributor, you wouldn't normally need to run this script, feel free to ask for help in the PR.