Skip to content

Conversation

@adrien-berchet
Copy link
Member

No description provided.

Copy link

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

Fixes Sphinx documentation format by implementing automatic conversion of GitHub-style admonitions to MyST format during the build process.

  • Adds preprocessing functionality to convert GitHub admonitions (like > [!NOTE]) to MyST syntax
  • Updates documentation source to reference a processed README file instead of the original
  • Adds cleanup for the processed README file in the Makefile

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.

File Description
docs/source/index.rst Updates include path to reference processed README file
docs/source/conf.py Adds GitHub admonition conversion logic and Sphinx preprocessing hook
docs/Makefile Includes processed README file in cleanup target

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@adrien-berchet adrien-berchet merged commit 15264bf into main Sep 8, 2025
9 checks passed
@adrien-berchet adrien-berchet deleted the doc_example branch September 12, 2025 08:32
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