Migrate unmaintained mkdocs to Sphinx + PyData theme#41
Merged
Conversation
JAlvarezJarreta
requested review from
bilalebi,
dpopleton,
ens-ftricomi and
ens-sb
Contributor
Coverage Report
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
license-eye has checked 61 files.
| Valid | Invalid | Ignored | Fixed |
|---|---|---|---|
| 33 | 2 | 26 | 0 |
Click to see the invalid file list
- docs/_static/custom-icons.js
- docs/_static/switcher.json
Use this command to fix any missing license headers
```bash
docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
</details>
ens-sb
previously approved these changes
Apr 24, 2026
JAlvarezJarreta
force-pushed
the
jalvarez/sphinx-pydata
branch
from
8e59547 to
c4b9041
Compare
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
2 participants
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.
After more than 1 year of not being maintained and the news that v2 is going to go on a different direction, keeping our documentation based on mkdocs is not reliable anymore. We could opt to choose for many different alternatives, but I have opted to rely on Sphinx with PyData theme (for version control), which is a much more stable system (still maintained and does not look it is going anywhere any time soon). Obviously this has mean quite a few changes in the coverage and documentation structure, but I believe the final result is quite similar (and even better in some parts) than what we had already.
Note: once approved I will produce a similar update on our Python template repository.