Really HimandGitHub
949af8abe5
## Description I noticed a very minor issue in the formatting of the Concepts > Pregel doc: (https://langchain-ai.github.io/langgraph/concepts/pregel/#high-level-api) (https://github.com/langchain-ai/langgraph/blob/main/docs/docs/concepts/pregel.md) You can see in the image below that there is a python codeblock, then a pycon block, and inside that block there is an extra triple-backtick/code fence, and then text at the bottom, which it appears like it is supposed to be a separate python block, like the one above it. I.e., clearly: ``` ```python print(graph.channels) ``` is intended to be: ```python print(graph.channels) ``` I'm pretty sure this is due to an extra whitespace character before the preceding closing code fence, which is throwing off the formatting.  My VS-Code/extensions can't really render the Markdown the way it appears on the Website, I think because of the tabs (Graph API vs. Functional API), but I noticed that if I remove the extra whitespace, the highlighting on the python codeblock is corrected: BEFORE: <img width="605" alt="Screenshot 2025-03-25 at 5 02 41 PM" src="https://github.com/user-attachments/assets/8474f103-c5ab-4c02-b22f-3d54b3363331" /> AFTER: <img width="277" alt="Screenshot 2025-03-25 at 5 02 50 PM" src="https://github.com/user-attachments/assets/a311b87b-859c-4aba-a4d8-6b063a155d90" /> ## Fix * Remove one whitespace character that was throwing off markdown rendering
Setup
To setup requirements for building docs you can run:
poetry install --with test
Serving documentation locally
To run the documentation server locally you can run:
make serve-docs
This will start the documentation server on http://127.0.0.1:8000/langgraph/.
Execute notebooks
If you would like to automatically execute all of the notebooks, to mimic the "Run notebooks" GHA, you can run:
python _scripts/prepare_notebooks_for_ci.py
./_scripts/execute_notebooks.sh
Note: if you want to run the notebooks without %pip install cells, you can run:
python _scripts/prepare_notebooks_for_ci.py --comment-install-cells
./_scripts/execute_notebooks.sh
prepare_notebooks_for_ci.py script will add VCR cassette context manager for each cell in the notebook, so that:
- when the notebook is run for the first time, cells with network requests will be recorded to a VCR cassette file
- when the notebook is run subsequently, the cells with network requests will be replayed from the cassettes
Adding new notebooks
If you are adding a notebook with API requests, it's recommended to record network requests so that they can be subsequently replayed. If this is not done, the notebook runner will make API requests every time the notebook is run, which can be costly and slow.
To record network requests, please make sure to first run prepare_notebooks_for_ci.py script.
Then, run
jupyter execute <path_to_notebook>
Once the notebook is executed, you should see the new VCR cassettes recorded in cassettes directory and discard the updated notebook.
Updating existing notebooks
If you are updating an existing notebook, please make sure to remove any existing cassettes for the notebook in cassettes directory (each cassette is prefixed with the notebook name), and then run the steps from the "Adding new notebooks" section above.
To delete cassettes for a notebook, you can run:
rm cassettes/<notebook_name>*