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

new dev scripts to help keep civic-docs updated w/ client icon & model changes #870

Merged
merged 5 commits into from
Aug 24, 2023

Conversation

jmcmichael
Copy link
Contributor

Adds a generate-icon-rst script that creates a civic.docs-aliases.rst file which includes RST aliases for every SVG icon in assets/icons. When included in a civic-docs RST template, allows the placement of the icon images anywhere in the text or tables in that template by using the icon's alias, e.g. |attribute-positive|, |fullcolor-gene|.

A helper script, generate-icon-data produces a JSON file containing an array of all the icons that serves as input to the generate-icon-rst script.

@github-actions
Copy link

You must specify one of the following labels: bugfix, housekeeping, new-feature, enhancement, ignore-for-release, dependencies in order for this PR to appear in the release notes.

@acoffman acoffman added the enhancement PR Label for improvements to existing functionality. Will appear in release notes. label Aug 24, 2023
@acoffman acoffman merged commit 47e1785 into main Aug 24, 2023
4 checks passed
@acoffman acoffman deleted the rst-icon-aliases branch August 24, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement PR Label for improvements to existing functionality. Will appear in release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants