Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Gitpod-ify the repository #548

Merged
merged 5 commits into from Aug 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Expand Up @@ -19,4 +19,4 @@ jobs:
- name: Install tox
run: python -m pip install --upgrade pip tox
- name: Run Tests
run: tox -e py,install,docs
run: make tests
15 changes: 15 additions & 0 deletions .gitpod.yml
@@ -0,0 +1,15 @@

tasks:
- init: pip install -r requirements.txt && pip install -e .

github:
prebuilds:
master: true
branches: true
pullRequests: true
pullRequestsFromForks: true
addCheck: true

vscode:
extensions:
- ms-python.python
8 changes: 8 additions & 0 deletions Makefile
@@ -0,0 +1,8 @@
all: format tests

format:
isort src/pydocstyle
black src/pydocstyle

tests:
tox -e py,install,docs
16 changes: 15 additions & 1 deletion README.rst
Expand Up @@ -21,6 +21,10 @@ pydocstyle - docstring style checker
.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/

.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
:target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
:alt: Gitpod ready-to-code

**pydocstyle** is a static analysis tool for checking compliance with Python
docstring conventions.

Expand All @@ -43,7 +47,7 @@ Install


Run
^^^^
^^^

.. code::

Expand All @@ -56,6 +60,16 @@ Run
D201: No blank lines allowed before function docstring (found 1)
...

Develop
^^^^^^^

You can use Gitpod to run pre-configured dev envrionment in the cloud right from your browser -

.. image:: https://gitpod.io/button/open-in-gitpod.svg
:target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
:alt: Open in Gitpod

Before submitting a PR make sure that you run `make all`.

Links
-----
Expand Down