From 2eb2ddfec30099af868409f8faa3b6298dacaf9d Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Fri, 28 Apr 2023 00:31:49 -0700 Subject: [PATCH] Fix broken link and update docs (#1690) --- .github/PULL_REQUEST_TEMPLATE/release.md | 3 +- CHANGELOG.md | 2 ++ README.rst | 4 --- docs/source/software_process.rst | 39 +++++++++++++++--------- 4 files changed, 28 insertions(+), 20 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index bf70a7223..8a15d5ee2 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -2,8 +2,7 @@ Prepare for release of PyNWB [version] ### Before merging: - [ ] Major and minor releases: Update package versions in `requirements.txt`, `requirements-dev.txt`, - `requirements-doc.txt`, `requirements-min.txt`, `setup.py` as needed - See https://requires.io/github/NeurodataWithoutBorders/pynwb/requirements/?branch=dev + `requirements-doc.txt`, `requirements-min.txt`, `environment-ros3.yml`, and `setup.py` as needed. - [ ] Check legal file dates and information in `Legal.txt`, `license.txt`, `README.rst`, `docs/source/conf.py`, and any other locations as needed - [ ] Update `setup.py` as needed diff --git a/CHANGELOG.md b/CHANGELOG.md index 898a43323..ea2ff4e8b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ ### Bug fixes - Remove unused, deprecated `codecov` package from dev installation requirements. @rly [#1688](https://github.com/NeurodataWithoutBorders/pynwb/pull/1688) +- Remove references to discontinued `requires.io` service in documentation. @rly + [#1690](https://github.com/NeurodataWithoutBorders/pynwb/pull/1690) ## PyNWB 2.3.2 (April 10, 2023) diff --git a/README.rst b/README.rst index 857f19891..ef37476e7 100644 --- a/README.rst +++ b/README.rst @@ -55,10 +55,6 @@ Overall Health .. image:: https://github.com/NeurodataWithoutBorders/pynwb/actions/workflows/deploy_release.yml/badge.svg :target: https://github.com/NeurodataWithoutBorders/pynwb/actions/workflows/deploy_release.yml -.. image:: https://requires.io/github/NeurodataWithoutBorders/pynwb/requirements.svg?branch=dev - :target: https://requires.io/github/NeurodataWithoutBorders/pynwb/requirements/?branch=dev - :alt: Requirements Status - .. image:: https://readthedocs.org/projects/pynwb/badge/?version=latest :target: https://pynwb.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status diff --git a/docs/source/software_process.rst b/docs/source/software_process.rst index 07e809c9f..f2ccb335d 100644 --- a/docs/source/software_process.rst +++ b/docs/source/software_process.rst @@ -32,11 +32,23 @@ codecov_, which shows line by line which lines are covered by the tests. .. _coverage: https://coverage.readthedocs.io .. _codecov: https://app.codecov.io/gh/NeurodataWithoutBorders/pynwb/tree/dev/src/pynwb --------------------------- -Requirement Specifications --------------------------- +------------------------- +Installation Requirements +------------------------- + +:pynwb:`setup.py ` contains a list of package dependencies and their version ranges allowed for +running PyNWB. As a library, upper bound version constraints create more harm than good in the long term (see this +`blog post`_) so we avoid setting upper bounds on requirements. + +If some of the packages are outdated, see :ref:`update_requirements_files`. -There are 5 kinds of requirements specification in PyNWB. +.. _blog post: https://iscinumpy.dev/post/bound-version-constraints/ + +-------------------- +Testing Requirements +-------------------- + +There are several kinds of requirements files used for testing PyNWB. The first one is the :pynwb:`requirements-min.txt ` file, which lists the package dependencies and their minimum versions for installing PyNWB. @@ -48,20 +60,19 @@ The third one is :pynwb:`requirements-dev.txt `, an entire development environment to use PyNWB, run PyNWB tests, check code style, compute coverage, and create test environments. -The fourth one is :pynwb:`requirements-doc.txt `, which lists the dependencies to generate the documentation for PyNWB. -Both this file and :pynwb:`requirements.txt ` are used by ReadTheDocs_ to initialize the local environment for Sphinx to run. +The final one is :pynwb:`environment-ros3.yml `, which lists the dependencies used to +test ROS3 streaming in PyNWB. -The final one is within :pynwb:`setup.py `, which contains a list of package dependencies and their version ranges allowed for -running PyNWB. - -In order to check the status of the required packages, requires.io_ is used to create a badge on the project -:pynwb:`README <#readme>`. If all the required packages are up to date, a green badge appears. +-------------------------- +Documentation Requirements +-------------------------- -If some of the packages are outdated, see :ref:`update_requirements_files`. +:pynwb:`requirements-doc.txt ` lists the dependencies to generate the documentation +for PyNWB. +Both this file and :pynwb:`requirements.txt ` are used by ReadTheDocs_ to initialize the +local environment for Sphinx to run. .. _ReadTheDocs: https://readthedocs.org/projects/pynwb/ -.. _requires.io: https://requires.io/github/NeurodataWithoutBorders/pynwb/requirements/?branch=dev - ------------------------- Versioning and Releasing