Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/repo-helper/repo_helper_sphinx_theme
Sphinx Theme for repo_helper.
https://github.com/repo-helper/repo_helper_sphinx_theme
documentation python repo-helper sphinx sphinx-theme
Last synced: about 1 month ago
JSON representation
Sphinx Theme for repo_helper.
- Host: GitHub
- URL: https://github.com/repo-helper/repo_helper_sphinx_theme
- Owner: repo-helper
- License: other
- Created: 2020-07-26T21:57:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T08:08:49.000Z (8 months ago)
- Last Synced: 2024-05-02T05:17:04.308Z (8 months ago)
- Topics: documentation, python, repo-helper, sphinx, sphinx-theme
- Language: Python
- Homepage: https://repo-helper-sphinx-theme.readthedocs.io/en/latest
- Size: 736 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
#########################
repo_helper_sphinx_theme
#########################
.. start short_desc
**Sphinx Theme for repo_helper.**
.. end short_desc
This is a modified version of the `alabaster `_ theme.
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/repo-helper-sphinx-theme/latest?logo=read-the-docs
:target: https://repo-helper-sphinx-theme.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/repo-helper/repo_helper_sphinx_theme/workflows/Docs%20Check/badge.svg
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/repo-helper/repo_helper_sphinx_theme/workflows/Linux/badge.svg
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/repo-helper/repo_helper_sphinx_theme/workflows/Windows/badge.svg
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/repo-helper/repo_helper_sphinx_theme/workflows/macOS/badge.svg
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/repo-helper/repo_helper_sphinx_theme/workflows/Flake8/badge.svg
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/repo-helper/repo_helper_sphinx_theme/workflows/mypy/badge.svg
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/repo-helper/repo_helper_sphinx_theme/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/repo-helper/repo_helper_sphinx_theme/
:alt: Requirements Status
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/repo-helper/repo_helper_sphinx_theme?logo=codefactor
:target: https://www.codefactor.io/repository/github/repo-helper/repo_helper_sphinx_theme
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/repo_helper_sphinx_theme
:target: https://pypi.org/project/repo_helper_sphinx_theme/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/repo_helper_sphinx_theme?logo=python&logoColor=white
:target: https://pypi.org/project/repo_helper_sphinx_theme/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/repo_helper_sphinx_theme
:target: https://pypi.org/project/repo_helper_sphinx_theme/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/repo_helper_sphinx_theme
:target: https://pypi.org/project/repo_helper_sphinx_theme/
:alt: PyPI - Wheel
.. |license| image:: https://img.shields.io/github/license/repo-helper/repo_helper_sphinx_theme
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/repo-helper/repo_helper_sphinx_theme
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/repo-helper/repo_helper_sphinx_theme/v0.0.3
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/repo-helper/repo_helper_sphinx_theme
:target: https://github.com/repo-helper/repo_helper_sphinx_theme/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/repo_helper_sphinx_theme
:target: https://pypi.org/project/repo_helper_sphinx_theme/
:alt: PyPI - Downloads
.. end shields
|
Installation
--------------
.. start installation
``repo_helper Theme`` can be installed from PyPI.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install repo_helper_sphinx_theme
.. end installation