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

Add mkdocs plugin #12

Merged
merged 8 commits into from
Nov 15, 2024
Merged

Add mkdocs plugin #12

merged 8 commits into from
Nov 15, 2024

Conversation

bollwyvl
Copy link
Contributor

@bollwyvl bollwyvl commented Nov 15, 2024 •
edited
Loading

References

Code changes

  • pyproject.toml
    • add [mkdocs] extra
    • add entry point
  • mkdocsext
    • add minimal config
    • wire up custom fence
  • tests
    • unit
      • verify basic build
      • verify relative paths to definitions
    • acceptance
      • verify xkcd example
  • docs
    • README.md
    • CHANGELOG.md
    • docs/use/mkdocs.md

User-facing changes

  • mkdocs users will be able to embed urljsf forms in their sites with minimal required configuration

Backwards-incompatible changes

  • n/a

@github-actions GitHub Actions
Copy link

View Docs on ReadTheDocs

@bollwyvl bollwyvl marked this pull request as ready for review November 15, 2024 20:17
@bollwyvl bollwyvl merged commit 2a5af0e into deathbeds:main Nov 15, 2024
10 checks passed
@bollwyvl bollwyvl deleted the gh-11-mkd branch November 15, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add mkdocs plugin
1 participant
@bollwyvl