https://github.com/domdfcoding/flake8-rst-docstrings-sphinx

Extension to flake8-rst-docstrings to filter out warnings related to Sphinx's built in options.
https://github.com/domdfcoding/flake8-rst-docstrings-sphinx

python

Last synced: 21 days ago
JSON representation

Extension to flake8-rst-docstrings to filter out warnings related to Sphinx's built in options.

• Host: GitHub
• URL: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx
• Owner: domdfcoding
• License: mit
• Created: 2020-10-21T22:09:45.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T08:20:05.000Z (6 months ago)
• Last Synced: 2024-06-12T04:44:18.568Z (5 months ago)
• Topics: python
• Language: Python
• Homepage:
• Size: 164 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

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

flake8-rst-docstrings-sphinx

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

.. start short_desc

**Extension to flake8-rst-docstrings to filter out warnings related to Sphinx's built in options.**

.. end short_desc

.. start shields

.. list-table::

	:stub-columns: 1

	:widths: 10 90

	* - Tests

	  - |actions_linux| |actions_windows| |actions_macos|

	* - Activity

	  - |commits-latest| |commits-since| |maintained|

	* - QA

	  - |codefactor| |actions_flake8| |actions_mypy|

	* - Other

	  - |license| |language| |requires|

.. |actions_linux| image:: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/workflows/Linux/badge.svg

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/actions?query=workflow%3A%22Linux%22

	:alt: Linux Test Status

.. |actions_windows| image:: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/workflows/Windows/badge.svg

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/actions?query=workflow%3A%22Windows%22

	:alt: Windows Test Status

.. |actions_macos| image:: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/workflows/macOS/badge.svg

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/actions?query=workflow%3A%22macOS%22

	:alt: macOS Test Status

.. |actions_flake8| image:: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/workflows/Flake8/badge.svg

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/actions?query=workflow%3A%22Flake8%22

	:alt: Flake8 Status

.. |actions_mypy| image:: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/workflows/mypy/badge.svg

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/actions?query=workflow%3A%22mypy%22

	:alt: mypy status

.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/flake8-rst-docstrings-sphinx/badge.svg

	:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/flake8-rst-docstrings-sphinx/

	:alt: Requirements Status

.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/flake8-rst-docstrings-sphinx?logo=codefactor

	:target: https://www.codefactor.io/repository/github/domdfcoding/flake8-rst-docstrings-sphinx

	:alt: CodeFactor Grade

.. |license| image:: https://img.shields.io/github/license/domdfcoding/flake8-rst-docstrings-sphinx

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/blob/master/LICENSE

	:alt: License

.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/flake8-rst-docstrings-sphinx

	:alt: GitHub top language

.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/flake8-rst-docstrings-sphinx/v0.0.0

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/pulse

	:alt: GitHub commits since tagged version

.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/flake8-rst-docstrings-sphinx

	:target: https://github.com/domdfcoding/flake8-rst-docstrings-sphinx/commit/master

	:alt: GitHub last commit

.. |maintained| image:: https://img.shields.io/maintenance/yes/2024

	:alt: Maintenance

.. end shields

Installation

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

.. start installation

``flake8-rst-docstrings-sphinx`` can be installed from GitHub.

To install with ``pip``:

.. code-block:: bash

	$ python -m pip install git+https://github.com/domdfcoding/flake8-rst-docstrings-sphinx

.. end installation