From bace50fbb8ab1bbbedfafdcc9499525fde5c859a Mon Sep 17 00:00:00 2001 From: Talley Lambert Date: Tue, 12 Sep 2023 11:24:55 -0400 Subject: [PATCH] docs: update fonticon docs (#198) --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature.md | 7 +++ docs/utilities/fonticon.md | 67 +++++++++++++++++++--------- pyproject.toml | 1 + 4 files changed, 54 insertions(+), 23 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0875ca61..8772ed28 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: 'bug' assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 00000000..8954faa7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,7 @@ +--- +name: Feature request +about: Request a new feature +title: '' +labels: 'enhancement' +assignees: '' +--- diff --git a/docs/utilities/fonticon.md b/docs/utilities/fonticon.md index aeb0ec19..8652f9e7 100644 --- a/docs/utilities/fonticon.md +++ b/docs/utilities/fonticon.md @@ -28,21 +28,44 @@ app.exec() ## Font Icon plugins -Ready-made fonticon packs are available as plugins: +Ready-made fonticon packs are available as plugins. -### [Font Awesome 5](https://fontawesome.com/v5/search) +A great way to search across most available icons libraries from a single +search interface is to use glyphsearch: + +If a font library you'd like to use is unavailable as a superqt plugin, +please [open a feature request](https://github.com/pyapp-kit/superqt/issues/new/choose) + + +### Font Awesome 6 + +Browse available icons at + +```bash +pip install fonticon-fontawesome6 +``` + +### Font Awesome 5 + +Browse available icons at ```bash pip install fonticon-fontawesome5 ``` -### [Font Awesome 6](https://fontawesome.com/v6/search) +### Material Design Icons 7 + +Browse available icons at ```bash -pip install fonticon-fontawesome6 +pip install fonticon-materialdesignicons7 ``` -### [Material Design Icons](https://materialdesignicons.com/) +### Material Design Icons 6 + +Browse available icons at +(note that the search defaults to v7, see changes from v6 in [the +changelog](https://pictogrammers.com/docs/library/mdi/releases/changelog/)) ```bash pip install fonticon-materialdesignicons6 @@ -55,7 +78,7 @@ pip install fonticon-materialdesignicons6 - `superqt.fonticon` is a pluggable system, and font icon packs may use the `"superqt.fonticon"` -entry point to register themselves with superqt. See [`fonticon-cookiecutter`](https://github.com/tlambert03/fonticon-cookiecutter) for a template, or look through the following repos for examples: +entry point to register themselves with superqt. See [`fonticon-cookiecutter`](https://github.com/tlambert03/fonticon-cookiecutter) for a template, or look through the following repos for examples: - - @@ -64,24 +87,24 @@ entry point to register themselves with superqt. See [`fonticon-cookiecutter`]( ## API ::: superqt.fonticon.icon - options: - heading_level: 3 +options: +heading_level: 3 ::: superqt.fonticon.setTextIcon - options: - heading_level: 3 +options: +heading_level: 3 ::: superqt.fonticon.font - options: - heading_level: 3 +options: +heading_level: 3 ::: superqt.fonticon.IconOpts - options: - heading_level: 3 +options: +heading_level: 3 ::: superqt.fonticon.addFont - options: - heading_level: 3 +options: +heading_level: 3 ## Animations @@ -89,13 +112,13 @@ the `animation` parameter to `icon()` accepts a subclass of `Animation` that will be ::: superqt.fonticon.Animation - options: - heading_level: 3 +options: +heading_level: 3 ::: superqt.fonticon.pulse - options: - heading_level: 3 +options: +heading_level: 3 ::: superqt.fonticon.spin - options: - heading_level: 3 +options: +heading_level: 3 diff --git a/pyproject.toml b/pyproject.toml index 7cab5be1..20f44533 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -75,6 +75,7 @@ font-mi6 = ["fonticon-materialdesignicons6"] font-mi7 = ["fonticon-materialdesignicons7"] [project.urls] +Documentation = "https://pyapp-kit.github.io/superqt/" Source = "https://github.com/pyapp-kit/superqt" Tracker = "https://github.com/pyapp-kit/superqt/issues" Changelog = "https://github.com/pyapp-kit/superqt/blob/main/CHANGELOG.md"