Skip to content

Commit

Permalink
Update docs development instructions in README (Lightning-Universe#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
kaushikb11 authored Apr 30, 2022
1 parent f85e425 commit 1b4b5e3
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ touch .env.json
Now copy paste the following into the `.env.json`
```json
{
"DOCS_DIR": "path/to/pytorch_lightning/docs/"
"DOCS_DIR": "path/to/pytorch_lightning/docs/source/"
}
```

Expand All @@ -104,20 +104,15 @@ Run the docs this way
grunt --project=docs
```

Building this will be slow at first... we recommend you disable the notebooks building (temporarily) to vastly speed up your docs development speed. To do this:
```bash
cd /path/to/pytorch-lightning/docs
ls
# (you'll see the conf.py file here). edit this document
```
When developing the docs, building docs can be VERY slow locally because of the notebook tutorials.
To speed this up, enable this flag in before building docs:

In the conf.py file enable this flag
```bash
# default is false
_FAST_DOCS_DEV = False
# builds notebooks which is slow
export PL_FAST_DOCS_DEV=0

# to build fast (not building the notebooks)
_FAST_DOCS_DEV = True
# fast notebook build which is fast
export PL_FAST_DOCS_DEV=1
```


Expand All @@ -128,7 +123,7 @@ First add the following entry to `.env.json`.

```json
{
"DOCS_DIR": "path/to/pytorch_lightning/docs/",
"DOCS_DIR": "path/to/pytorch_lightning/docs/source/",
"TUTORIALS_DIR": "path/to/tutorial/directory/docs"
}
```
Expand Down

0 comments on commit 1b4b5e3

Please sign in to comment.