Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs README on how to build docs (#13465) 

update docs README on how to build docs

Co-authored-by: Jeroen Delcour <jeroen@track32.nl>
This commit is contained in:
Jeroen Delcour 2022-07-17 20:48:10 +02:00 committed by GitHub
parent 258b58e33b
commit d18f45b75e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@ -43,7 +43,6 @@ Run these commands
```bash ```bash
git submodule update --init --recursive git submodule update --init --recursive
pip install -e . -r requirements/pytorch/docs.txt
make docs make docs
``` ```
@ -52,11 +51,12 @@ and open `docs/build/html/index.html` in your browser.
When you send a PR the continuous integration will run tests and build the docs. You can access a preview of the html pages in the When you send a PR the continuous integration will run tests and build the docs. You can access a preview of the html pages in the
_Artifacts_ tab in CircleCI when you click on the task named _build-Docs_ of _ci-tests_ at the bottom of the PR page. _Artifacts_ tab in CircleCI when you click on the task named _build-Docs_ of _ci-tests_ at the bottom of the PR page.
Notes (Optional): Notes:
- You need to have LaTeX installed for rendering math equations. You can for example install TeXLive by doing one of the following: - You need to have LaTeX installed for rendering math equations. You can for example install TeXLive with the necessary extras by doing one of the following:
- on Ubuntu (Linux) run `apt-get install texlive` or otherwise follow the instructions on the TeXLive website - on Ubuntu (Linux) run `sudo apt-get update && sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures`
- use the [RTD docker image](https://hub.docker.com/r/readthedocs/build) - use the [RTD docker image](https://hub.docker.com/r/readthedocs/build)
- You need to have pandoc installed for rendering Jupyter Notebooks. On Ubuntu (Linux), you can run: `sudo apt-get install pandoc`
## Developing docs ## Developing docs