{"id":31702393,"url":"https://github.com/fraoustin/sphinx_fontawesome","last_synced_at":"2026-02-28T18:33:20.273Z","repository":{"id":47579957,"uuid":"46574656","full_name":"fraoustin/sphinx_fontawesome","owner":"fraoustin","description":"module sphinx for add fontawesome","archived":false,"fork":false,"pushed_at":"2021-08-23T13:35:31.000Z","size":24,"stargazers_count":13,"open_issues_count":7,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-22T01:00:02.938Z","etag":null,"topics":["active","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fraoustin.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-20T16:49:43.000Z","updated_at":"2025-11-18T13:13:55.000Z","dependencies_parsed_at":"2022-08-30T04:31:37.086Z","dependency_job_id":null,"html_url":"https://github.com/fraoustin/sphinx_fontawesome","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/fraoustin/sphinx_fontawesome","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraoustin%2Fsphinx_fontawesome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraoustin%2Fsphinx_fontawesome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraoustin%2Fsphinx_fontawesome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraoustin%2Fsphinx_fontawesome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fraoustin","download_url":"https://codeload.github.com/fraoustin/sphinx_fontawesome/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fraoustin%2Fsphinx_fontawesome/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29876377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T22:37:10.609Z","status":"ssl_error","status_checked_at":"2026-02-26T22:37:09.019Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["active","sphinx"],"created_at":"2025-10-08T21:51:19.548Z","updated_at":"2026-02-28T18:33:20.258Z","avatar_url":"https://github.com/fraoustin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinx fontawesome\r\n##################\r\n\r\nIt is a extension for sphinx.\r\n\r\nAdd directive for use fontawesome \r\n\r\nInstallation\r\n------------\r\n\r\n::\r\n\r\n    pip install sphinx_fontawesome\r\n\r\n\r\nOr\r\n\r\n::\r\n\r\n    git clone https://github.com/fraoustin/sphinx_fontawesome.git\r\n    cd sphinx_fontawesome\r\n    python setup.py install\r\n\r\nUse\r\n---\r\n\r\nIn your conf.py\r\n\r\n::\r\n\r\n    import sphinx_fontawesome\r\n    extensions = ['sphinx_fontawesome']\r\n\r\nIn your rst file, you can use\r\n\r\n* directive\r\n\r\n::\r\n\r\n   .. fa:: check\r\n\r\n* role\r\n\r\n::\r\n\r\n   :fa:`check`\r\n   :fa:`check lg`\r\n   :fa:`square-o`\r\n\r\n* substitution\r\n\r\n::\r\n\r\n    |check|\r\n    |square-o|\r\n\r\nIf you have changed the value of rst_prolog in your conf.py, and you'd like to use subsitution you\r\ncan add ``sphinx_fontawesome.prolog`` to it.\r\n\r\n::\r\n\r\n    rst_prolog = sphinx_fontawesome.prolog + \"my prolog\"\r\n\r\nFor add css fontawesome, you can cssfiles option of your theme\r\n\r\n::\r\n\r\n    html_theme_options = {\r\n        'cssfiles': [\"http://netdna.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css\"]\r\n    }\r\n\r\nor create _templates/layout.html\r\n\r\n::\r\n\r\n    {%- extends \"yourtheme/layout.html\" %}\r\n    {%- block extrahead %}\r\n    {{ super() }}\r\n    \u003clink href=\"http://netdna.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css\" rel=\"stylesheet\"\u003e\r\n    {% endblock %}\r\n\r\nYou can generate todo list if you add in css (as font-awesome css)\r\n\r\n::\r\n    table.field-list th.field-name {\r\n        color: white;\r\n    }\r\n\r\n    table.field-list th.field-name .fa {\r\n        color: black;\r\n    }\r\n\r\nand write todo list\r\n\r\n::\r\n\r\n    :|o|: task 1\r\n    :|x|: task 2\r\n    :|x|: task 3\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffraoustin%2Fsphinx_fontawesome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffraoustin%2Fsphinx_fontawesome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffraoustin%2Fsphinx_fontawesome/lists"}