Skip to content

[Internal] create docs_directories.txt file #860

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.

Sign up for GitHub

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

Merged
ravidclassiq merged 2 commits into from
Mar 10, 2025
Merged

[Internal] create docs_directories.txt file #860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f4d940
Add list of dirs for docs integration
ravidclassiq Mar 10, 2025
95f10ba
Add test for docs directories file
ravidclassiq Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .internal/docs_directories.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
algorithms
applications
functions
tutorials
6 changes: 6 additions & 0 deletions tests/internal/test_paths_for_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

ROOT = Path(subprocess.getoutput("git rev-parse --show-toplevel")) # noqa: S605
PATHS_FOR_DOCS = ROOT / ".internal" / "paths_for_docs.yaml"
DOCS_DIRECTORIES = ROOT / ".internal" / "docs_directories.txt"

"""
This test checks if all paths in the files_to_copy_for_docs.yaml file exist.
Expand All @@ -26,3 +27,8 @@ def test_paths_to_copy_for_docs():
missing_paths.append(path)

assert not missing_paths, f"The following paths do not exist: {missing_paths}"


def test_docs_directories():
dir_list = DOCS_DIRECTORIES.read_text().splitlines()
assert all((ROOT / path).exists() for path in dir_list), f"Make sure all directories in {DOCS_DIRECTORIES} actually exist"