Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update Llama Deploy documentation build #16403

Merged
merged 32 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
84144f5
repare
masci Oct 7, 2024
0cef049
adjust import script and navigation
masci Oct 7, 2024
37bcc56
remove debug comment
masci Oct 7, 2024
9dfa8e3
document what empty folders are for
masci Oct 7, 2024
e4e378e
remove BUILD file
masci Oct 7, 2024
930051b
use poetry to install dependencies
masci Oct 7, 2024
a60521f
fix nav bar
masci Oct 8, 2024
282ef87
fix RTD build script
masci Oct 8, 2024
008699f
fix mkdocstrings dep
masci Oct 8, 2024
5cb2641
update the contribution guide
masci Oct 8, 2024
834f908
fix plugin defs
masci Oct 8, 2024
7093ae0
revert
masci Oct 8, 2024
c2b310d
make the script poetry-runnable
masci Oct 8, 2024
af38af2
remove duplicated readme for clarity
masci Oct 8, 2024
500b878
add it back
masci Oct 8, 2024
8c33a3b
add prepare-for-build script
masci Oct 8, 2024
d65ebce
mention the configuration step in the contributing docs
masci Oct 8, 2024
b3bb49f
revert debug branch
masci Oct 8, 2024
b418329
fix README and update the version in the docs
masci Oct 8, 2024
2b3009d
convert github admonitions into mkdocs
masci Oct 8, 2024
01c3e50
docs: update BGEM3Demo.ipynb (#16395)
eltociear Oct 7, 2024
c773571
Fix ZyteWebReader article parsing (#16401)
rakeshmehta0308 Oct 7, 2024
4235f64
don't include tool calls if there was none (#16408)
logan-markewich Oct 7, 2024
f332cd8
Fix ChatMessage serialization with janky openai types (#16410)
logan-markewich Oct 7, 2024
a716d1c
Add ObjectBox Vector Store Integration (#16314)
shubham0204 Oct 7, 2024
b0564af
feat: add Docling reader and node parser (#16406)
vagenas Oct 8, 2024
9055d08
MultiModal.HuggingFaceMultiModal: fix errors and README, add stream_c…
g-hano Oct 8, 2024
efb4fd3
fix prepare_for_build
logan-markewich Oct 8, 2024
9eac899
fix prepare_for_build
logan-markewich Oct 8, 2024
bc10ddd
more fixing
logan-markewich Oct 8, 2024
12aa918
last fix
logan-markewich Oct 8, 2024
591ad2e
Merge branch 'main' into massi/llama-deploy-docs
logan-markewich Oct 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ build:
tools:
python: "3.12"
jobs:
post_create_environment:
- python -m pip install poetry
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH cd docs && poetry install
pre_build:
- python docs/merge_llama_deploy_docs.py
- cd docs && poetry run merge-llama-deploy-docs

mkdocs:
configuration: docs/mkdocs.yml

python:
install:
- requirements: docs/requirements.txt
4 changes: 4 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# docs build
docs/api_reference/llama_deploy/*
docs/module_guides/llama_deploy/*
llama_deploy
9 changes: 0 additions & 9 deletions docs/BUILD

This file was deleted.

44 changes: 0 additions & 44 deletions docs/DOCS_README.md

This file was deleted.

56 changes: 56 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Documentation

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.

## Build Docs

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
`docs` directory:

```
cd llama_index/docs
```

From now on, we assume all the commands will be executed from the `docs` directory.

Install all dependencies required for building docs (mainly `mkdocs` and its extension):

- [Install poetry](https://python-poetry.org/docs/#installation) - this will help you manage package dependencies
- `poetry install` - this will install all dependencies needed for building docs

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-notebooks`:

```
poetry run serve --skip-notebooks
```

> [!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.
2 changes: 2 additions & 0 deletions docs/docs/api_reference/llama_deploy/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Documentation content will be pulled from https://github.com/run-llama/llama_deploy,
make sure to run `python docs/merge_llama_deploy_docs.py` before building docs.
2 changes: 2 additions & 0 deletions docs/docs/module_guides/llama_deploy/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Documentation content will be pulled from https://github.com/run-llama/llama_deploy,
make sure to run `python docs/merge_llama_deploy_docs.py` before building docs.
97 changes: 0 additions & 97 deletions docs/merge_llama_deploy_docs.py

This file was deleted.

Loading
Loading