Skip to content

Conversation

@amrit110
Copy link
Member

PR Type

Documentation

Short Description

  • Migrate to use mkdocs that adheres to the vector template

@amrit110 amrit110 requested a review from Copilot May 27, 2025 14:12
@amrit110 amrit110 self-assigned this May 27, 2025
@amrit110 amrit110 added the documentation Improvements or additions to documentation label May 27, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR replaces the existing Sphinx-based documentation with an MkDocs setup using the vector template.

  • Removes all Sphinx configuration and static assets
  • Updates the main index and adds a new api.md for mkdocstrings integration
  • Adjusts pre-commit and CI workflows to support MkDocs builds and deployment

Reviewed Changes

Copilot reviewed 26 out of 40 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/source/conf.py Removed legacy Sphinx config
docs/source/_static/custom.js Removed unused RequireJS config
docs/index.md Updated front-page content and replaced Sphinx toctree with MkDocs links
docs/api.md Added new API reference page for mkdocstrings
.pre-commit-config.yaml Excluded mkdocs.yml from YAML checks
.github/workflows/docs.yml Added CI workflow to build and deploy MkDocs site
Files not reviewed (14)
  • .github/workflows/docs_build.yml: Language not supported
  • .github/workflows/docs_deploy.yml: Language not supported
  • docs/Makefile: Language not supported
  • docs/make.bat: Language not supported
  • docs/overrides/partials/copyright.html: Language not supported
  • docs/overrides/partials/logo.html: Language not supported
  • docs/source/_templates/base.html: Language not supported
  • docs/source/_templates/custom-class-template.rst: Language not supported
  • docs/source/_templates/custom-module-template.rst: Language not supported
  • docs/source/_templates/page.html: Language not supported
  • docs/source/reference/api/atomgen.data.data_collator.rst: Language not supported
  • docs/source/reference/api/atomgen.data.rst: Language not supported
  • docs/source/reference/api/atomgen.data.tokenizer.rst: Language not supported
  • docs/source/reference/api/atomgen.data.utils.rst: Language not supported
Comments suppressed due to low confidence (1)

docs/source/conf.py:1

  • [nitpick] After migrating to MkDocs, the legacy docs/source directory (and its Sphinx files) appears unused—consider removing or archiving this directory to simplify the structure and avoid confusion.
"""Configuration file for the Sphinx documentation builder."""

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@amrit110 amrit110 merged commit aa68f48 into main May 27, 2025
4 of 5 checks passed
@amrit110 amrit110 deleted the migrate_to_mkdocs branch May 27, 2025 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants