mirror of
https://github.com/hwchase17/langchain
synced 2024-10-29 17:07:25 +00:00
cf792891f1
Updated design of the "API Reference" text Here is an example of the current format:  It changed to `langchain.retrievers.ElasticSearchBM25Retriever` format. The same format as it is in the API Reference Toc. It also resembles code: `from langchain.retrievers import ElasticSearchBM25Retriever` (namespace THEN class_name) Current format is `ElasticSearchBM25Retriever from langchain.retrievers` (class_name THEN namespace) This change is in line with other formats and improves readability. @baskaryan |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| code-block-loader.js | ||
| docusaurus.config.js | ||
| generate_api_reference_links.py | ||
| ignore_build.sh | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| settings.ini | ||
| sidebars.js | ||
| vercel_build.sh | ||
| vercel.json | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Continuous Integration
Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.
$ yarn ci