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

Publish the MkDocs SVG rendering plugin as a PyPI package #54

Closed
aabounegm opened this issue Jun 18, 2023 · 1 comment · Fixed by #58
Closed

Publish the MkDocs SVG rendering plugin as a PyPI package #54

aabounegm opened this issue Jun 18, 2023 · 1 comment · Fixed by #58

Comments

@aabounegm
Copy link
Member

Currently, the generate_svgs.py plugin is registered as a hook. To be able to reuse it with other projects that depend on rzk, it should be packaged as a proper MkDocs plugin and published on PyPI so that others can install and use it.

Possible configuration options:

  • Path to rzk binary (defaults to using PATH)

Question: Is it desirable to automatically install rzk (from GitHub releases) if not found?

@fizruk
Copy link
Member

fizruk commented Jun 19, 2023

I think for the PyPI package by default you should assume that rzk is in PATH.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants