chore: migrate documentation from Sphinx to MkDocs#10
Merged
Conversation
AN0DA
commented
Mar 29, 2026
AN0DA
commented
Owner
- Updated the documentation build process to use MkDocs instead of Sphinx, enhancing the user experience with a more modern interface.
- Added a new MkDocs configuration file and adjusted the Makefile for building the documentation.
- Removed Sphinx-related files and configurations, including the previous GitHub Actions workflow for Sphinx.
- Introduced new documentation files and updated existing ones to align with the MkDocs structure.
- Updated the README to reflect the new documentation build instructions and structure.
- Updated the documentation build process to use MkDocs instead of Sphinx, enhancing the user experience with a more modern interface. - Added a new MkDocs configuration file and adjusted the Makefile for building the documentation. - Removed Sphinx-related files and configurations, including the previous GitHub Actions workflow for Sphinx. - Introduced new documentation files and updated existing ones to align with the MkDocs structure. - Updated the README to reflect the new documentation build instructions and structure.
Contributor
Test Results553 tests 542 ✅ 7s ⏱️ Results for commit f8f6845. |
Contributor
Test Results553 tests 542 ✅ 7s ⏱️ Results for commit f8f6845. ♻️ This comment has been updated with latest results. |
Contributor
Test Results553 tests 542 ✅ 8s ⏱️ Results for commit f8f6845. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.