Skip to content

Commit

Permalink
Remove table of notebooks from readme (#1796)
Browse files Browse the repository at this point in the history
  • Loading branch information
eaidova authored Mar 6, 2024
1 parent 0cc873f commit 2662a36
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 259 deletions.
7 changes: 1 addition & 6 deletions .ci/test_notebooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,8 @@ def get_parsed_requirements(requirements_file: str) -> Set:

def test_readme():
"""
Test that all notebooks have a README file and exist in the Notebooks README
Test that all notebooks have a README file
"""
notebooks_readme_path = Path("README.md")
notebooks_readme = notebooks_readme_path.read_text(encoding="utf-8")
for item in Path("notebooks").iterdir():
if item.is_dir():
# item is a notebook directory
Expand All @@ -46,9 +44,6 @@ def test_readme():
assert "README.md" in [
filename.name for filename in item.iterdir()
], f"README not found in {item}"
assert (
str(item.relative_to(notebooks_readme_path.parent)) in notebooks_readme
), f"{item} not found in notebooks README: {notebooks_readme_path}"


def test_requirements_docker():
Expand Down
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ To do this, there are a few requirements that all notebooks need to pass.

1. Notebooks in this repository typically rely on a shared `requirements.txt` file.
However, contributors are encouraged to install the required packages at the top of their notebook using
`!pip install -q ...` commands. This allows the notebooks to be run independently as standalone examples.
`%pip install -q ...` commands. This allows the notebooks to be run independently as standalone examples.
To maintain package compatibility, contributors are expected to install the same versions of packages
as specified in the shared `requirements.txt` file. This helps ensure consistency in our testing pipelines
and prevents dependency conflicts.
Expand Down Expand Up @@ -158,10 +158,6 @@ Additional subsections, e.g license information.
## Installation Instructions
[link to installation guide, other important information for install process]
```

Every notebook is also added to the notebooks overview table in the main
[`README.md`](https://github.com/openvinotoolkit/openvino_notebooks/blob/main/README.md) and the
[`README.md`](https://github.com/openvinotoolkit/openvino_notebooks/blob/main/notebooks/README.md) in the notebooks directory.
Notebooks that work in Binder have a _Launch Binder_ badge in the `README.md` files.
In the same way, notebooks that work in Google Colab have a _Launch Colab_ badge in the `README.md` files.

Expand Down
Loading

0 comments on commit 2662a36

Please sign in to comment.