Skip to content

Commit 2662a36

Browse files
authored
Remove table of notebooks from readme (openvinotoolkit#1796)
1 parent 0cc873f commit 2662a36

File tree

5 files changed

+12
-259
lines changed

5 files changed

+12
-259
lines changed

.ci/test_notebooks.py

+1-6
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,8 @@ def get_parsed_requirements(requirements_file: str) -> Set:
3434

3535
def test_readme():
3636
"""
37-
Test that all notebooks have a README file and exist in the Notebooks README
37+
Test that all notebooks have a README file
3838
"""
39-
notebooks_readme_path = Path("README.md")
40-
notebooks_readme = notebooks_readme_path.read_text(encoding="utf-8")
4139
for item in Path("notebooks").iterdir():
4240
if item.is_dir():
4341
# item is a notebook directory
@@ -46,9 +44,6 @@ def test_readme():
4644
assert "README.md" in [
4745
filename.name for filename in item.iterdir()
4846
], f"README not found in {item}"
49-
assert (
50-
str(item.relative_to(notebooks_readme_path.parent)) in notebooks_readme
51-
), f"{item} not found in notebooks README: {notebooks_readme_path}"
5247

5348

5449
def test_requirements_docker():

CONTRIBUTING.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ To do this, there are a few requirements that all notebooks need to pass.
8383

8484
1. Notebooks in this repository typically rely on a shared `requirements.txt` file.
8585
However, contributors are encouraged to install the required packages at the top of their notebook using
86-
`!pip install -q ...` commands. This allows the notebooks to be run independently as standalone examples.
86+
`%pip install -q ...` commands. This allows the notebooks to be run independently as standalone examples.
8787
To maintain package compatibility, contributors are expected to install the same versions of packages
8888
as specified in the shared `requirements.txt` file. This helps ensure consistency in our testing pipelines
8989
and prevents dependency conflicts.
@@ -158,10 +158,6 @@ Additional subsections, e.g license information.
158158
## Installation Instructions
159159
[link to installation guide, other important information for install process]
160160
```
161-
162-
Every notebook is also added to the notebooks overview table in the main
163-
[`README.md`](https://github.com/openvinotoolkit/openvino_notebooks/blob/main/README.md) and the
164-
[`README.md`](https://github.com/openvinotoolkit/openvino_notebooks/blob/main/notebooks/README.md) in the notebooks directory.
165161
Notebooks that work in Binder have a _Launch Binder_ badge in the `README.md` files.
166162
In the same way, notebooks that work in Google Colab have a _Launch Colab_ badge in the `README.md` files.
167163

0 commit comments

Comments
 (0)