Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fetch external sources #17941

Merged
merged 17 commits into from
Jul 3, 2023
Merged

docs: fetch external sources #17941

merged 17 commits into from
Jul 3, 2023

Conversation

Borda
Copy link
Member

@Borda Borda commented Jun 27, 2023

What does this PR do?

making docs as standalone resources without needing to pull S3 assets
pending on Lightning-AI/utilities#142

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

cc @Borda @tchaton @carmocca @justusschock @awaelchli

@Borda Borda added docs Documentation related priority: 1 Medium priority task labels Jun 27, 2023
@Borda Borda added this to the 2.0.x milestone Jun 27, 2023
@github-actions github-actions bot added app Generic label for Lightning App package fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package labels Jun 27, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 27, 2023

⚡ Required checks status: All passing 🟢

Groups summary

🟢 fabric: Docs
Check ID Status
make-doctest (fabric) success
make-html (fabric) success

These checks are required after the changes to docs/source-fabric/conf.py, docs/source-fabric/fundamentals/accelerators.rst, docs/source-fabric/fundamentals/launch.rst, docs/source-fabric/fundamentals/precision.rst, requirements/docs.txt.

🟢 pytorch_lightning: Docs
Check ID Status
make-doctest (pytorch) success
make-html (pytorch) success

These checks are required after the changes to docs/source-pytorch/accelerators/gpu_intermediate.rst, docs/source-pytorch/accelerators/tpu_basic.rst, docs/source-pytorch/advanced/speed.rst, docs/source-pytorch/common/early_stopping.rst, docs/source-pytorch/common/trainer.rst, docs/source-pytorch/conf.py, docs/source-pytorch/data/datamodule.rst, docs/source-pytorch/debug/debugging_basic.rst, docs/source-pytorch/model/build_model_intermediate.rst, docs/source-pytorch/starter/introduction.rst, requirements/docs.txt.

🟢 lightning_app: Docs
Check ID Status
make-doctest (app) success
make-html (app) success

These checks are required after the changes to docs/source-app/conf.py, docs/source-app/examples/file_server/file_server_content.rst, docs/source-app/examples/github_repo_runner/github_repo_runner_content.rst, docs/source-app/get_started/go_beyond_training_content.rst, docs/source-app/get_started/jumpstart_from_app_gallery.rst, docs/source-app/get_started/what_app_can_do.rst, docs/source-app/glossary/secrets.rst, docs/source-app/glossary/storage/path.rst, docs/source-app/levels/intermediate/level_9.rst, docs/source-app/workflows/build_command_line_interface/cli_client.rst, docs/source-app/workflows/build_rest_api/add_api.rst, docs/source-app/workflows/byoc/aws_console.rst, requirements/docs.txt.


Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

@Borda Borda marked this pull request as draft June 27, 2023 21:53
@Borda Borda marked this pull request as ready for review June 27, 2023 23:24
@Borda
Copy link
Member Author

Borda commented Jun 28, 2023

okk, it seems that Sphinx does not include resources linked only in HTML section

.. raw:: html

    <video width="50%" max-width="400px" controls
    poster="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/trainer_flags/thumb/check_val_every_n_epoch.jpg"
    src="https://pl-bolts-doc-images.s3.us-east-2.amazonaws.com/pl_docs/trainer_flags/check_val_every_n_epoch.mp4"></video>

Consider replacement with https://github.com/sphinx-contrib/video
checking sphinx-contrib/video#26

@Borda Borda marked this pull request as ready for review June 28, 2023 15:36
@mergify mergify bot added the ready PRs ready to be merged label Jun 29, 2023
@Borda Borda enabled auto-merge (squash) June 29, 2023 16:58
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no docs preview so I don't really know what I'm approving 🤞

requirements/docs.txt Outdated Show resolved Hide resolved
@Borda
Copy link
Member Author

Borda commented Jun 29, 2023

There's no docs preview so I don't really know what I'm approving crossed_fingers

there is, see the checks: https://pytorch-lightning--17941.org.readthedocs.build/en/17941/

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>
@Borda Borda mentioned this pull request Jun 30, 2023
7 tasks
@Borda Borda merged commit 00a0f2e into master Jul 3, 2023
30 checks passed
@Borda Borda deleted the docs/fetch-s3 branch July 3, 2023 18:16
Borda added a commit that referenced this pull request Jul 7, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 00a0f2e)
Borda added a commit that referenced this pull request Jul 7, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 00a0f2e)
Borda added a commit that referenced this pull request Jul 7, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 00a0f2e)
Borda added a commit that referenced this pull request Jul 7, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 00a0f2e)
lantiga pushed a commit that referenced this pull request Jul 10, 2023
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit 00a0f2e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app Generic label for Lightning App package docs Documentation related fabric lightning.fabric.Fabric pl Generic label for PyTorch Lightning package priority: 1 Medium priority task ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants