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.

Sign up for GitHub

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

Jump to bottom

doc: Make AntaTest documentation Great Again #514

Merged
merged 20 commits into from
Mar 19, 2024
Merged

doc: Make AntaTest documentation Great Again #514

merged 20 commits into from
Mar 19, 2024

Conversation

gmuloc
Copy link
Collaborator

@gmuloc gmuloc commented Jan 5, 2024 •
edited
Loading

Description

Leverage mkdocstring blocks - https://mkdocstrings.github.io/usage/theming/#customization

  • dark magic voodoo template (they CAN be made better)
  • Ability to render table of attributes for nested classes.

Fixes #550

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)

@gmuloc gmuloc changed the title Doc: Make AntaTest documentation Great Again doc: Make AntaTest documentation Great Again Jan 5, 2024
@mtache mtache added this to the v1.0.0 milestone Jan 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 9, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 9, 2024

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 5, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions GitHub Actions
Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

carl-baillargeon
carl-baillargeon approved these changes Mar 19, 2024
View reviewed changes
Copy link
Contributor

@carl-baillargeon carl-baillargeon left a comment

Choose a reason for hiding this comment

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

De toute beauté!

@gmuloc gmuloc merged commit 84a8680 into aristanetworks:main Mar 19, 2024
19 checks passed
carl-baillargeon added a commit to carl-baillargeon/anta that referenced this pull request Mar 20, 2024
@gmuloc @carl-baillargeon
doc: Make AntaTest documentation Great Again (aristanetworks#514)
af55ab3 
Co-authored-by: Carl Baillargeon <carl.baillargeon@arista.com>
@gmuloc gmuloc mentioned this pull request Apr 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carl-baillargeon carl-baillargeon carl-baillargeon approved these changes

Assignees

@gmuloc gmuloc

Labels
rn: doc
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging this pull request may close these issues.

mkdocs gives warning of module deprecated
3 participants
@gmuloc @carl-baillargeon @mtache