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

CI: Docs build preview in each PR (#1494) 

* store html artifacts in circle ci

* add note to contributing.md
This commit is contained in:
Adrian Wälchli 2020-04-19 23:07:16 +02:00 committed by GitHub
parent c71bd73acb
commit 7131685ae3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.circleci/config.yml
View File

@ -76,6 +76,10 @@ jobs:
steps:
- checkout
- *make_docs
- store_artifacts:
# allows us to preview the generated html pages
path: docs/build/html/
destination: html
Formatting:
docker:

2
.github/CONTRIBUTING.md vendored
View File

@ -120,6 +120,8 @@ make html
```
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
_Artifacts_ tab in CircleCI when you click on the task named _ci/circleci: Build-Docs_ at the bottom of the PR page.
### Testing