Fix `make docs_build` and related scripts (#7276)
**Description: a description of the change**
Fixed `make docs_build` and related scripts which caused errors. There
are several changes.
First, I made the build of the documentation and the API Reference into
two separate commands. This is because it takes less time to build. The
commands for documents are `make docs_build`, `make docs_clean`, and
`make docs_linkcheck`. The commands for API Reference are `make
api_docs_build`, `api_docs_clean`, and `api_docs_linkcheck`.
It looked like `docs/.local_build.sh` could be used to build the
documentation, so I used that. Since `.local_build.sh` was also building
API Rerefence internally, I removed that process. `.local_build.sh` also
added some Bash options to stop in error or so. Futher more added `cd
"${SCRIPT_DIR}"` at the beginning so that the script will work no matter
which directory it is executed in.
`docs/api_reference/api_reference.rst` is removed, because which is
generated by `docs/api_reference/create_api_rst.py`, and added it to
.gitignore.
Finally, the description of CONTRIBUTING.md was modified.
**Issue: the issue # it fixes (if applicable)**
https://github.com/hwchase17/langchain/issues/6413
**Dependencies: any dependencies required for this change**
`nbdoc` was missing in group docs so it was added. I installed it with
the `poetry add --group docs nbdoc` command. I am concerned if any
modifications are needed to poetry.lock. I would greatly appreciate it
if you could pay close attention to this file during the review.
**Tag maintainer**
- General / Misc / if you don't know who to tag: @baskaryan
If this PR needs any additional changes, I'll be happy to make them!
---------
Co-authored-by: Bagatur <baskaryan@gmail.com>
2023-07-12 02:05:14 +00:00
|
|
|
#!/usr/bin/env bash
|
|
|
|
|
|
|
|
|
|
set -o errexit
|
|
|
|
|
set -o nounset
|
|
|
|
|
set -o pipefail
|
|
|
|
|
set -o xtrace
|
|
|
|
|
|
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "$0")"; pwd)"
|
|
|
|
|
cd "${SCRIPT_DIR}"
|
|
|
|
|
|
2023-10-10 19:55:19 +00:00
|
|
|
mkdir -p ../_dist
|
2023-12-06 18:05:43 +00:00
|
|
|
rsync -ruv --exclude node_modules --exclude api_reference --exclude .venv --exclude .docusaurus . ../_dist
|
2023-10-10 19:55:19 +00:00
|
|
|
cd ../_dist
|
2023-10-15 21:59:36 +00:00
|
|
|
poetry run python scripts/model_feat_table.py
|
2023-10-19 21:05:24 +00:00
|
|
|
cp ../cookbook/README.md src/pages/cookbook.mdx
|
2023-12-01 22:03:36 +00:00
|
|
|
mkdir -p docs/templates
|
2023-12-01 21:09:36 +00:00
|
|
|
cp ../templates/docs/INDEX.md docs/templates/index.md
|
2023-12-17 20:55:49 +00:00
|
|
|
poetry run python scripts/copy_templates.py
|
2023-11-06 15:07:25 +00:00
|
|
|
wget https://raw.githubusercontent.com/langchain-ai/langserve/main/README.md -O docs/langserve.md
|
2023-12-04 20:50:56 +00:00
|
|
|
|
|
|
|
|
yarn
|
|
|
|
|
|
2024-01-05 17:15:00 +00:00
|
|
|
poetry run quarto preview docs
|
