Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add gh-admonition plugin #966

Merged
merged 11 commits into from
Dec 16, 2024

Conversation

titom73
Copy link
Collaborator

@titom73 titom73 commented Dec 13, 2024

Description

Add support to convert Github Admonitions to basic mkdocs admonitions using PGijsbers/admonitions. This conversion helps to get nice document in both worlds: Github and Mkdocs.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have run pre-commit for code linting and typing (pre-commit run)
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes (tox -e testenv)

@titom73 titom73 marked this pull request as ready for review December 13, 2024 13:39
Copy link

codspeed-hq bot commented Dec 13, 2024

CodSpeed Performance Report

Merging #966 will not alter performance

Comparing titom73:docs/admonitions-gh-mkdocs (e4256f7) with main (a11aca7)

Summary

✅ 8 untouched benchmarks

@titom73 titom73 force-pushed the docs/admonitions-gh-mkdocs branch from e6688e3 to f766501 Compare December 14, 2024 11:30
@titom73 titom73 requested a review from gmuloc December 14, 2024 12:33
docs/cli/nrfu.md Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@gmuloc gmuloc merged commit 9876833 into aristanetworks:main Dec 16, 2024
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants