Skip to content

Commit acd526b

Browse files
committed
docs: contributing.rst: updates for renamed requirements files
1 parent 875cc01 commit acd526b

File tree

2 files changed

+7
-9
lines changed

2 files changed

+7
-9
lines changed

docs/contributing.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ environment, and install the developer dependencies::
1515
$ cd trio-websocket
1616
$ python3 -m venv venv
1717
$ source venv/bin/activate
18-
(venv) $ pip install -r requirements-dev.txt
18+
(venv) $ pip install -r requirements-dev-full.txt
1919
(venv) $ pip install -e .
2020

2121
This example uses Python's built-in ``venv`` package, but you can of course use
2222
other virtual environment tools such as ``virtualenvwrapper``.
2323

24-
The ``requirements-dev.in`` file contains extra dependencies only needed for
25-
development, such as PyTest, Sphinx, etc. Then ``requirements-dev.txt`` is
26-
generated from ``setup.py`` and ``requirements-dev.in`` so that dependencies
24+
The ``requirements-dev.in`` and ``requirements-extras.in`` files contain extra
25+
dependencies only needed for development, such as PyTest, Sphinx, etc.
26+
The ``.in`` files and ``setup.py`` are used to generate the pinned manifests
27+
``requirements-dev-full.txt`` and ``requirements-dev.txt``, so that dependencies
2728
used in development and CI builds do not change arbitrarily over time.
2829

2930
Unit Tests

docs/index.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,9 @@ Autobahn Test Suite <https://github.com/crossbario/autobahn-testsuite>`__.
1818
:alt: Python Versions
1919
.. image:: https://img.shields.io/github/license/HyperionGray/trio-websocket.svg?style=flat-square
2020
:alt: MIT License
21-
.. image:: https://img.shields.io/travis/com/HyperionGray/trio-websocket.svg?style=flat-square&branch=master
21+
.. image:: https://img.shields.io/github/actions/workflow/status/HyperionGray/trio-websocket/ci.yml
2222
:alt: Build Status
23-
:target: https://travis-ci.com/HyperionGray/trio-websocket
24-
.. image:: https://img.shields.io/coveralls/github/HyperionGray/trio-websocket.svg?style=flat-square
25-
:alt: Coverage
26-
:target: https://coveralls.io/github/HyperionGray/trio-websocket?branch=master
23+
:target: https://github.com/HyperionGray/trio-websocket/actions/workflows/ci.yml
2724

2825
.. toctree::
2926
:maxdepth: 2

0 commit comments

Comments
 (0)