Add MkDocs Documentation with GitHub Actions Deployment #2832
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduced mkdocs.yml for site configuration and theme settings. - Added deploy-docs.yml for GitHub Actions to automate documentation deployment. - Created index.md as the main documentation page with installation and usage instructions. - Added reference documentation for API models and Hugging Face vision-language models. - Removed outdated README.md from docs directory.
Add MkDocs configuration and documentation files
- Upgrade checkout action to v4 for improved performance. - Configure Git credentials for the GitHub Actions bot. - Upgrade setup-python action to v5 and specify Python version 3.9. - Implement caching for dependencies to optimize build times.
…trings versions - Replace the installation of documentation dependencies with explicit versioning for mkdocs and mkdocstrings.
|
|
|
Hey @StellaAthena and @baberabb, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR introduces MkDocs integration to the LM Evaluation Harness repository, significantly enhancing documentation readability and accessibility. It provides:
MkDocs setup: Configured via
mkdocs.ymlwith a structured navigation, Material theme, and enhanced user experience through syntax highlighting, copy-to-clipboard, and dark/light mode toggle.GitHub Actions workflow: Automatically deploys documentation updates to GitHub Pages upon changes in the
docs/folder,mkdocs.yml, or the workflow file itself, ensuring docs stay up-to-date.Comprehensive documentation: Clearly structured markdown files under
docs/to assist users and contributors, including:API reference: Integration of autogenerated documentation using
mkdocstrings, providing clear and detailed API docs for better developer experience.Benefits:
This aligns with the project's goals to facilitate research, benchmarking, and model evaluation.