Skip to content

Commit

Permalink
Exclude some examples from docs navigation (#17081)
Browse files Browse the repository at this point in the history
Co-authored-by: Jirka <[email protected]>
  • Loading branch information
awaelchli and Borda authored Mar 15, 2023
1 parent f25dfbe commit 01834c8
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
2 changes: 1 addition & 1 deletion _notebooks
18 changes: 17 additions & 1 deletion docs/source-pytorch/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,24 @@
# -- Project documents -------------------------------------------------------
if _SHOULD_COPY_NOTEBOOKS:
AssistantCLI.copy_notebooks(
PATH_RAW_NB, PATH_HERE, "notebooks", patterns=[".", "course_UvA-DL", "lightning_examples"]
PATH_RAW_NB,
PATH_HERE,
"notebooks",
patterns=[".", "course_UvA-DL", "lightning_examples"],
)
# TODO: Complete converting the missing items and add them back
ignore = [
"course_UvA-DL/13-contrastive-learning",
"lightning_examples/augmentation_kornia",
"lightning_examples/finetuning-scheduler",
"lightning_examples/reinforce-learning-DQN",
"lightning_examples/text-transformers",
"lightning_examples/warp-drive",
]
for file in ignore:
file = os.path.join(PATH_HERE, "notebooks", file)
if os.path.exists(file):
os.remove(file)


def _transform_changelog(path_in: str, path_out: str) -> None:
Expand Down
3 changes: 0 additions & 3 deletions docs/source-pytorch/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,9 +259,6 @@ Current Lightning Users
:glob:

notebooks/**/*
PyTorch Lightning 101 class <https://www.youtube.com/playlist?list=PLaMu-SDt_RB5NUm67hU2pdE75j6KaIOv2>
From PyTorch to PyTorch Lightning [Blog] <https://towardsdatascience.com/from-pytorch-to-pytorch-lightning-a-gentle-introduction-b371b7caaf09>
From PyTorch to PyTorch Lightning [Video] <https://www.youtube.com/watch?v=QHww1JH7IDU>

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 01834c8

Please sign in to comment.