Skip to content

Conversation

@sushmanthreddy
Copy link
Contributor

Add test to validate markdown files referenced in mkdocs.yml

This PR adds a test to ensure all markdown files referenced in the navigation section of mkdocs.yml exist in the docs directory. This helps prevent broken links and ensures documentation integrity.

Changes:

  • Added new test test_nav_files_exist that:
    • Parses mkdocs.yml to extract markdown file paths
    • Verifies each file exists in docs/docs directory
    • Provides clear error message for any missing files

The test helps catch:

  • Typos in file paths
  • Missing documentation files
  • Incorrect file references

Test location: tests/docs/test_mkdocs_links.py

@okhat okhat merged commit b88caa3 into stanfordnlp:main Oct 31, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants