Unverified Commit cd4e07a8 authored by Sylvain Gugger's avatar Sylvain Gugger Committed by GitHub
Browse files

Add note about doc generation (#4770)

parent 492b352a
...@@ -7,6 +7,14 @@ you can install them with the following command, at the root of the code reposit ...@@ -7,6 +7,14 @@ you can install them with the following command, at the root of the code reposit
pip install -e ".[docs]" pip install -e ".[docs]"
``` ```
---
**NOTE**
You only need to generate the documentation to inspect it locally (if you're planning changes and want to
check how they look like before committing for instance). You don't have to commit the built documentation.
---
## Packages installed ## Packages installed
Here's an overview of all the packages installed. If you ran the previous command installing all packages from Here's an overview of all the packages installed. If you ran the previous command installing all packages from
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment