Skip to content

Commit d77726a

Browse files
committed
Drop codecov and fix Read the Docs configuration (#30)
* Drop codecov and fix Read the Docs configuration (#29) - Remove codecov.yaml and codecov badge from README - Remove codecov, coverage, and pytest-cov from dev dependencies - Remove coverage tool configuration from pyproject.toml - Remove coverage-related entries from .gitignore - Remove coverage target from Makefile - Remove coverage references from CONTRIBUTING.rst - Update deprecated Sphinx settings in docs/conf.py (source_suffix and master_doc) - Add API documentation generation to .readthedocs.yaml using build.jobs.pre_build * fix: update pyupgrade to v3.21.2 for Python 3.14 compatibility
1 parent 6b785de commit d77726a

File tree

14 files changed

+777
-86
lines changed

14 files changed

+777
-86
lines changed

.gitignore

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,11 @@ var/
3535
pip-log.txt
3636
pip-delete-this-directory.txt
3737

38-
# Unit test / coverage reports
38+
# Unit test reports
3939
htmlcov/
4040
.tox/
41-
.coverage
42-
.coverage.*
4341
.cache
4442
nosetests.xml
45-
coverage.xml
46-
*,cover
4743
.hypothesis/
4844

4945
# Translations

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ repos:
88
- id: end-of-file-fixer
99
- id: trailing-whitespace
1010
- repo: https://github.com/asottile/pyupgrade
11-
rev: v3.15.0
11+
rev: v3.21.2
1212
hooks:
1313
- id: pyupgrade
1414
args: [--py310-plus]

.readthedocs.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ build:
77
os: ubuntu-24.04
88
tools:
99
python: "3.10"
10+
jobs:
11+
pre_build:
12+
- rm -f docs/multicodec.rst docs/modules.rst
13+
- python -m sphinx.ext.apidoc -o docs/ multicodec
1014

1115
sphinx:
1216
configuration: docs/conf.py

CONTRIBUTING.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,6 @@ The project provides several ``make`` targets to help with development:
118118
run linting, type checking, and tests. This is the recommended command to run
119119
before submitting a pull request.
120120

121-
* ``make coverage`` - Run tests with coverage reporting and open the HTML report
122-
in your browser.
123-
124121
For a full list of available commands, run ``make help``.
125122

126123
7. Commit your changes and push your branch to GitHub::
@@ -150,7 +147,3 @@ Tips
150147
To run a subset of tests::
151148

152149
$ pytest tests/test_multicodec.py
153-
154-
To run tests with coverage::
155-
156-
$ make coverage

Makefile

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ help:
2222
@echo "lint - run pre-commit hooks on all files"
2323
@echo "typecheck - run mypy type checking"
2424
@echo "test - run tests quickly with the default Python"
25-
@echo "coverage - run tests with coverage report"
2625
@echo "docs-ci - generate docs for CI"
2726
@echo "docs - generate docs and open in browser"
2827
@echo "servedocs - serve docs with live reload"
@@ -48,7 +47,6 @@ clean-test:
4847
rm -fr .tox/
4948
rm -fr .mypy_cache
5049
rm -fr .ruff_cache
51-
rm -f .coverage
5250
rm -fr htmlcov/
5351

5452
setup:
@@ -66,12 +64,6 @@ typecheck:
6664
test:
6765
python -m pytest tests
6866

69-
coverage:
70-
coverage run --source multicodec -m pytest tests
71-
coverage report -m
72-
coverage html
73-
$(BROWSER) htmlcov/index.html
74-
7567
docs-ci:
7668
rm -f docs/multicodec.rst
7769
rm -f docs/modules.rst

README.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ py-multicodec
77
.. image:: https://github.com/multiformats/py-multicodec/actions/workflows/tox.yml/badge.svg?branch=master
88
:target: https://github.com/multiformats/py-multicodec/actions/workflows/tox.yml
99

10-
.. image:: https://codecov.io/gh/multiformats/py-multicodec/branch/master/graph/badge.svg
11-
:target: https://codecov.io/gh/multiformats/py-multicodec
12-
1310
.. image:: https://readthedocs.org/projects/py-multicodec/badge/?version=stable
1411
:target: https://py-multicodec.readthedocs.io/en/stable/?badge=stable
1512
:alt: Documentation Status

codecov.yaml

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@
4545
templates_path = ['_templates']
4646

4747
# The suffix of source filenames.
48-
source_suffix = '.rst'
48+
source_suffix = {'.rst': 'restructuredtext'}
4949

5050
# The encoding of source files.
5151
# source_encoding = 'utf-8-sig'
5252

53-
# The master toctree document.
54-
master_doc = 'index'
53+
# The root toctree document.
54+
root_doc = 'index'
5555

5656
# General information about the project.
5757
project = 'py-multicodec'

0 commit comments

Comments
 (0)