https://github.com/repo-helper/repo_helper_rtd

Manage ReadTheDocs documentation with repo-helper.
https://github.com/repo-helper/repo_helper_rtd

python readthedocs repo-helper rtd

Last synced: about 1 month ago
JSON representation

Manage ReadTheDocs documentation with repo-helper.

• Host: GitHub
• URL: https://github.com/repo-helper/repo_helper_rtd
• Owner: repo-helper
• License: mit
• Created: 2020-12-10T22:41:32.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T18:12:15.000Z (3 months ago)
• Last Synced: 2024-10-12T22:59:52.679Z (2 months ago)
• Topics: python, readthedocs, repo-helper, rtd
• Language: Python
• Homepage: https://repo-helper-rtd.readthedocs.io/en/latest
• Size: 217 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
################

repo_helper_rtd

################

.. start short_desc

**Manage ReadTheDocs documentation with repo-helper.**

.. end short_desc

.. 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-rtd/latest?logo=read-the-docs

	:target: https://repo-helper-rtd.readthedocs.io/en/latest

	:alt: Documentation Build Status

.. |docs_check| image:: https://github.com/repo-helper/repo_helper_rtd/workflows/Docs%20Check/badge.svg

	:target: https://github.com/repo-helper/repo_helper_rtd/actions?query=workflow%3A%22Docs+Check%22

	:alt: Docs Check Status

.. |actions_linux| image:: https://github.com/repo-helper/repo_helper_rtd/workflows/Linux/badge.svg

	:target: https://github.com/repo-helper/repo_helper_rtd/actions?query=workflow%3A%22Linux%22

	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/repo-helper/repo_helper_rtd/workflows/Windows/badge.svg

	:target: https://github.com/repo-helper/repo_helper_rtd/actions?query=workflow%3A%22Windows%22

	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/repo-helper/repo_helper_rtd/workflows/macOS/badge.svg

	:target: https://github.com/repo-helper/repo_helper_rtd/actions?query=workflow%3A%22macOS%22

	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/repo-helper/repo_helper_rtd/workflows/Flake8/badge.svg

	:target: https://github.com/repo-helper/repo_helper_rtd/actions?query=workflow%3A%22Flake8%22

	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/repo-helper/repo_helper_rtd/workflows/mypy/badge.svg

	:target: https://github.com/repo-helper/repo_helper_rtd/actions?query=workflow%3A%22mypy%22

	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/repo-helper/repo_helper_rtd/badge.svg

	:target: https://dependency-dash.repo-helper.uk/github/repo-helper/repo_helper_rtd/

	:alt: Requirements Status

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/repo-helper/repo_helper_rtd?logo=codefactor

	:target: https://www.codefactor.io/repository/github/repo-helper/repo_helper_rtd

	:alt: CodeFactor Grade

.. |pypi-version| image:: https://img.shields.io/pypi/v/repo_helper_rtd

	:target: https://pypi.org/project/repo_helper_rtd/

	:alt: PyPI - Package Version

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/repo_helper_rtd?logo=python&logoColor=white

	:target: https://pypi.org/project/repo_helper_rtd/

	:alt: PyPI - Supported Python Versions

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/repo_helper_rtd

	:target: https://pypi.org/project/repo_helper_rtd/

	:alt: PyPI - Supported Implementations

.. |wheel| image:: https://img.shields.io/pypi/wheel/repo_helper_rtd

	:target: https://pypi.org/project/repo_helper_rtd/

	:alt: PyPI - Wheel

.. |license| image:: https://img.shields.io/github/license/repo-helper/repo_helper_rtd

	:target: https://github.com/repo-helper/repo_helper_rtd/blob/master/LICENSE

	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/repo-helper/repo_helper_rtd

	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/repo-helper/repo_helper_rtd/v0.1.1

	:target: https://github.com/repo-helper/repo_helper_rtd/pulse

	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/repo-helper/repo_helper_rtd

	:target: https://github.com/repo-helper/repo_helper_rtd/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_rtd

	:target: https://pypi.org/project/repo_helper_rtd/

	:alt: PyPI - Downloads

.. end shields

Installation

--------------

.. start installation

``repo_helper_rtd`` can be installed from PyPI.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install repo_helper_rtd

.. end installation