Fix make docs_build and related scripts
#7276
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
dosubot
bot
added
🤖:bug
|
this is amazing, thanks so much @os1ma!! |
|
Thanks for merging! I also appreciate this amazing project! |
aerrober
pushed a commit
to aerrober/langchain-fork
that referenced
this pull request
Jul 24, 2023
**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)**
langchain-ai#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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description: a description of the change
Fixed
make docs_buildand 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, andmake docs_linkcheck. The commands for API Reference aremake api_docs_build,api_docs_clean, andapi_docs_linkcheck.It looked like
docs/.local_build.shcould be used to build the documentation, so I used that. Since.local_build.shwas also building API Rerefence internally, I removed that process..local_build.shalso added some Bash options to stop in error or so. Futher more addedcd "${SCRIPT_DIR}"at the beginning so that the script will work no matter which directory it is executed in.docs/api_reference/api_reference.rstis removed, because which is generated bydocs/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)
#6413
Dependencies: any dependencies required for this change
nbdocwas missing in group docs so it was added. I installed it with thepoetry add --group docs nbdoccommand. 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
If this PR needs any additional changes, I'll be happy to make them!