{"id":13553330,"url":"https://github.com/ionelmc/sphinx-py3doc-enhanced-theme","last_synced_at":"2025-03-22T06:32:36.758Z","repository":{"id":17550833,"uuid":"20353661","full_name":"ionelmc/sphinx-py3doc-enhanced-theme","owner":"ionelmc","description":"A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.","archived":false,"fork":false,"pushed_at":"2021-06-06T12:44:31.000Z","size":2717,"stargazers_count":24,"open_issues_count":1,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-14T14:47:21.277Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ionelmc.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-31T10:20:30.000Z","updated_at":"2024-02-28T13:42:47.000Z","dependencies_parsed_at":"2022-09-19T10:21:21.697Z","dependency_job_id":null,"html_url":"https://github.com/ionelmc/sphinx-py3doc-enhanced-theme","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fsphinx-py3doc-enhanced-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fsphinx-py3doc-enhanced-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fsphinx-py3doc-enhanced-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ionelmc%2Fsphinx-py3doc-enhanced-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ionelmc","download_url":"https://codeload.github.com/ionelmc/sphinx-py3doc-enhanced-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221824050,"owners_count":16886755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-08-01T12:02:22.223Z","updated_at":"2024-10-28T12:09:59.805Z","avatar_url":"https://github.com/ionelmc.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"========\nOverview\n========\n\n.. start-badges\n\n.. list-table::\n    :stub-columns: 1\n\n    * - docs\n      - |docs|\n    * - tests\n      - | |travis| |requires|\n        |\n    * - demo\n      - `default \u003chttp://ionelmc.github.io/sphinx-py3doc-enhanced-theme/default/\u003e`_,\n        `bare \u003chttp://ionelmc.github.io/sphinx-py3doc-enhanced-theme/bare/\u003e`_\n    * - package\n      - | |version| |wheel| |supported-versions| |supported-implementations|\n        | |commits-since|\n.. |docs| image:: https://readthedocs.org/projects/sphinx-py3doc-enhanced-theme/badge/?style=flat\n    :target: https://sphinx-py3doc-enhanced-theme.readthedocs.io/\n    :alt: Documentation Status\n\n.. |travis| image:: https://api.travis-ci.com/ionelmc/sphinx-py3doc-enhanced-theme.svg?branch=master\n    :alt: Travis-CI Build Status\n    :target: https://travis-ci.com/github/ionelmc/sphinx-py3doc-enhanced-theme\n\n.. |requires| image:: https://requires.io/github/ionelmc/sphinx-py3doc-enhanced-theme/requirements.svg?branch=master\n    :alt: Requirements Status\n    :target: https://requires.io/github/ionelmc/sphinx-py3doc-enhanced-theme/requirements/?branch=master\n\n.. |version| image:: https://img.shields.io/pypi/v/sphinx-py3doc-enhanced-theme.svg\n    :alt: PyPI Package latest release\n    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/sphinx-py3doc-enhanced-theme.svg\n    :alt: PyPI Wheel\n    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-py3doc-enhanced-theme.svg\n    :alt: Supported versions\n    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/sphinx-py3doc-enhanced-theme.svg\n    :alt: Supported implementations\n    :target: https://pypi.org/project/sphinx-py3doc-enhanced-theme\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/ionelmc/sphinx-py3doc-enhanced-theme/v2.4.0.svg\n    :alt: Commits since latest release\n    :target: https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/compare/v2.4.0...master\n\n\n\n.. end-badges\n\nA theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.\n\n* Free software: BSD 2-Clause License\n\nInstallation\n============\n\n::\n\n    pip install sphinx_py3doc_enhanced_theme\n\nAdd this in your documentation's ``conf.py``:\n\n.. sourcecode:: python\n\n    import sphinx_py3doc_enhanced_theme\n    html_theme = \"sphinx_py3doc_enhanced_theme\"\n    html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]\n\nCustomization\n=============\n\nNo extra styling\n----------------\n\nThis theme has some extra styling like different fonts, text shadows for headings, slightly different styling for inline code and code blocks.\n\nTo get the original styling Python 3 docs have add this in you ``conf.py``:\n\n.. sourcecode:: python\n\n    html_theme_options = {\n        'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',\n        'bodyfont': '\"Lucida Grande\",Arial,sans-serif',\n        'headfont': '\"Lucida Grande\",Arial,sans-serif',\n        'codefont': 'monospace,sans-serif',\n        'linkcolor': '#0072AA',\n        'visitedlinkcolor': '#6363bb',\n        'extrastyling': False,\n    }\n    pygments_style = 'friendly'\n\nCustom favicon\n--------------\n\nTo have a custom favicon create a ``theme`` directory near your ``conf.py`` and add this ``theme.conf`` in it:\n\n.. sourcecode:: ini\n\n    [theme]\n    inherit = sphinx_py3doc_enhanced_theme\n\nThen create a ``favicon.png`` in the ``static`` directory.\n\nAnd then edit your ``conf.py`` to have something like this:\n\n.. sourcecode:: python\n\n    import sphinx_py3doc_enhanced_theme\n    html_theme = \"theme\"\n    html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path(), \".\"]\n\nThe final file structure should be like this::\n\n    docs\n    ├── conf.py\n    └── theme\n        ├── static\n        │   └── favicon.png\n        └── theme.conf\n\nA bit of extra css\n------------------\n\n.. sourcecode:: python\n\n    html_theme_options = {\n        'appendcss': 'div.body code.descclassname { display: none }',\n    }\n\nExamples\n========\n\n* http://python-aspectlib.readthedocs.org/en/latest/\n* http://python-manhole.readthedocs.org/en/latest/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionelmc%2Fsphinx-py3doc-enhanced-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fionelmc%2Fsphinx-py3doc-enhanced-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fionelmc%2Fsphinx-py3doc-enhanced-theme/lists"}