docs: building releases (#16967)

* docs: building releases

* codeowners

* todo

* rev

* on *

* push tag

* name
This commit is contained in:
Jirka Borovec 2023-03-07 05:12:03 +01:00 committed by GitHub
parent b2b6449be7
commit a96d976567
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 8 deletions

10
.github/CODEOWNERS vendored
View File

@ -18,14 +18,16 @@
/docs/ @edenlightning @lantiga @borda @awaelchli @RobertLaurella
/.github/*.md @edenlightning @williamfalcon @lantiga @borda
/.github/ISSUE_TEMPLATE/ @edenlightning @borda @tchaton @awaelchli
/docs/source-fabric/conf.py @borda @awaelchli @carmocca
/docs/source-fabric/index.rst @awaelchli @lantiga @carmocca
/docs/source-pytorch/conf.py @borda @awaelchli @carmocca
/docs/source-pytorch/index.rst @williamfalcon @lantiga
/docs/source-pytorch/levels @williamfalcon @RobertLaurella
/docs/source-pytorch/expertise_levels @williamfalcon @RobertLaurella
/docs/source/ @williamfalcon @RobertLaurella @tchaton @awaelchli
/docs/source/conf.py @borda @awaelchli @carmocca
/docs/source/index.rst @williamfalcon @lantiga
/docs/source/expertise_levels @williamfalcon @RobertLaurella
/docs/source-app/ @williamfalcon @RobertLaurella @tchaton @awaelchli
/docs/source-app/conf.py @borda @awaelchli @carmocca
/docs/source-app/index.rst @williamfalcon @lantiga
/docs/source-app/expertise_levels @williamfalcon @RobertLaurella
# PyTorch Lightning
/src/lightning/pytorch @williamfalcon @awaelchli @carmocca @justusschock

View File

@ -1,9 +1,10 @@
name: Check Docs
name: Build Docs
# https://github.com/marketplace/actions/sphinx-build
on:
push:
branches: ["master", "release/*"]
tags: ["*"]
# use this event type to share secrets with forks.
# it's important that the PR head SHA is checked out to run the changes
pull_request_target:
@ -166,9 +167,17 @@ jobs:
# Uploading docs to GCS, so they can be served on lightning.ai
- name: Upload docs/stable to GCS 🪣
if: startsWith(github.ref, 'refs/heads/release/')
# todo: consider nuke the bucket content before upload
run: gsutil -m rsync -d -R docs/build/html/ gs://lightning-docs-${{ matrix.pkg-name }}/stable
# Uploading docs to GCS, so they can be served on lightning.ai
- name: Upload docs/latest to GCS 🪣
if: github.ref == 'refs/heads/master'
# todo: consider nuke the bucket content before upload
run: gsutil -m rsync -d -R docs/build/html/ gs://lightning-docs-${{ matrix.pkg-name }}/latest
# Uploading docs to GCS, so they can be served on lightning.ai
- name: Upload docs/latest to GCS 🪣
if: startsWith(github.ref, 'refs/tags/')
# todo: consider nuke the bucket content before upload
run: gsutil -m rsync -d -R docs/build/html/ gs://lightning-docs-${{ matrix.pkg-name }}/${{ github.ref_name }}"

View File

@ -16,12 +16,15 @@ clean:
rm -rf .mypy_cache
rm -rf .pytest_cache
rm -rf ./docs/build
rm -rf ./docs/source-fabric/generated
rm -rf ./docs/source-fabric/*/generated
rm -rf ./docs/source-fabric/api
rm -rf ./docs/source-pytorch/notebooks
rm -rf ./docs/source-pytorch/generated
rm -rf ./docs/source-pytorch/*/generated
rm -rf ./docs/source-pytorch/api
rm -rf ./docs/source/generated
rm -rf ./docs/source/*/generated
rm -rf ./docs/source-app/generated
rm -rf ./docs/source-app/*/generated
rm -rf build
rm -rf dist
rm -rf *.egg-info
@ -47,7 +50,7 @@ test: clean
docs: clean
pip install -e . --quiet -r requirements/app/docs.txt
cd docs/source && $(MAKE) html
cd docs/source-app && $(MAKE) html
update:
git submodule update --init --recursive --remote