Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,11 @@ var/
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
# Unit test reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ repos:
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/asottile/pyupgrade
rev: v3.15.0
rev: v3.21.2
hooks:
- id: pyupgrade
args: [--py310-plus]
Expand Down
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ build:
os: ubuntu-24.04
tools:
python: "3.10"
jobs:
pre_build:
- rm -f docs/multicodec.rst docs/modules.rst
- python -m sphinx.ext.apidoc -o docs/ multicodec

sphinx:
configuration: docs/conf.py
Expand Down
7 changes: 0 additions & 7 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,6 @@ The project provides several ``make`` targets to help with development:
run linting, type checking, and tests. This is the recommended command to run
before submitting a pull request.

* ``make coverage`` - Run tests with coverage reporting and open the HTML report
in your browser.

For a full list of available commands, run ``make help``.

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

$ pytest tests/test_multicodec.py

To run tests with coverage::

$ make coverage
8 changes: 0 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ help:
@echo "lint - run pre-commit hooks on all files"
@echo "typecheck - run mypy type checking"
@echo "test - run tests quickly with the default Python"
@echo "coverage - run tests with coverage report"
@echo "docs-ci - generate docs for CI"
@echo "docs - generate docs and open in browser"
@echo "servedocs - serve docs with live reload"
Expand All @@ -48,7 +47,6 @@ clean-test:
rm -fr .tox/
rm -fr .mypy_cache
rm -fr .ruff_cache
rm -f .coverage
rm -fr htmlcov/

setup:
Expand All @@ -66,12 +64,6 @@ typecheck:
test:
python -m pytest tests

coverage:
coverage run --source multicodec -m pytest tests
coverage report -m
coverage html
$(BROWSER) htmlcov/index.html

docs-ci:
rm -f docs/multicodec.rst
rm -f docs/modules.rst
Expand Down
3 changes: 0 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ py-multicodec
.. image:: https://github.com/multiformats/py-multicodec/actions/workflows/tox.yml/badge.svg?branch=master
:target: https://github.com/multiformats/py-multicodec/actions/workflows/tox.yml

.. image:: https://codecov.io/gh/multiformats/py-multicodec/branch/master/graph/badge.svg
:target: https://codecov.io/gh/multiformats/py-multicodec

.. image:: https://readthedocs.org/projects/py-multicodec/badge/?version=stable
:target: https://py-multicodec.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
Expand Down
2 changes: 0 additions & 2 deletions codecov.yaml

This file was deleted.

6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = {'.rst': 'restructuredtext'}

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

# The master toctree document.
master_doc = 'index'
# The root toctree document.
root_doc = 'index'

# General information about the project.
project = 'py-multicodec'
Expand Down
Loading