getodk / getodk/docs

Add support for fontawesome icons in docs text

Open
#854 1 comment 0 reactions 0 assignees View on GitHub
coding discussion easy
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

I don't know if we have a need for it,
but I am using it in another Sphinx project and I didn't want to forget to mention it here.

This is potentially useful for things like writing about UI.
(Or maybe not! We've managed so far without it...)

https://github.com/fraoustin/sphinx_fontawesome

Contributor guide

Open the contributing guide

Research direction

Review the repository's Sphinx documentation setup and the linked sphinx_fontawesome project first. Clarify whether icon support is wanted and which documentation use cases it should cover; done should include an agreed integration and a successful docs build demonstrating the intended icon rendering.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.