Skip to content

Commit d62beb4

Browse files
bskinnbskinn
authored
Merge pull request #197 from bskinn/release-2.1
Merge to stable for v2.1 release
2 parents a704c38 + d92d5c0 commit d62beb4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+4979
-2474
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
tests/resource/objects_mkdoc_zlib0.inv binary
2+

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: [bskinn] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: pypi/sphobjinv # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: bskinn # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: ['https://paypal.me/btskinn'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Bug Report
3+
about: Create a bug report to help improve the project
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Brief description**
11+
<!-- Clear and concise description of the bug. -->
12+
13+
**Expected behavior**
14+
<!-- Description of what you expected to happen. -->
15+
16+
**Actual behavior**
17+
<!-- Description of what actually happened. -->
18+
19+
**To reproduce**
20+
<!--
21+
Steps to reproduce the behavior:
22+
1. Open '...'
23+
2. Type '...'
24+
3. See error
25+
-->
26+
27+
**Attachments**
28+
<!--
29+
If possible, please paste in an inventory file that
30+
demonstrates the bug, or provide a link to a relevant
31+
inventory on web.
32+
33+
If relevant, paste in screenshot(s) demonstrating
34+
the bug.
35+
-->
36+
37+
**System information**
38+
- Device:
39+
- OS:
40+
41+
**Python environment**
42+
43+
*Python*
44+
<!--
45+
Please paste the output of `$ {python} --version --version`
46+
executed in the relvant environment.
47+
-->
48+
49+
*Libraries*
50+
<!--
51+
Please paste the output of `$ pip list` or `$ pip freeze`
52+
executed in the relevant environment.
53+
-->
54+
55+
**Additional information**
56+
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. E.g., I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
18+
19+
**Additional context**
20+
<!--
21+
Add any other context or screenshots about the feature request here. If there's a
22+
specific inventory file that helps demonstrate the behavior you want, attach it here.
23+
-->

‎.github/pull_request_template.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- THANKS FOR YOUR CONTRIBUTION!! -->
2+
3+
**Is the PR a fix or a feature?**
4+
<!-- Please indicate the type of change the PR will make. -->
5+
6+
**Describe the changes in the PR**
7+
<!--
8+
Whatever level of detail is necessary to describe the changes well.
9+
A simple reference to associated issue(s) may suffice here
10+
(e.g., "Closes #113"), if the description/discussion there is
11+
complete enough.
12+
-->
13+
14+
**Does this PR close any issues?**
15+
<!--
16+
If not indicated in the above PR description, indicate here
17+
which issue(s) are closed by the PR, if any; e.g.:
18+
19+
Closes #112 and closes #117.
20+
21+
Please use a separate 'closes' with each issue number,
22+
to be sure that Github links the PR correctly to each closed issue.
23+
-->
24+
25+
**Does the PR change/update the following, if relevant?**
26+
<!--
27+
All changes to code, even internal-only changes, should have
28+
a CHANGELOG entry. Documentation changes are usually only required
29+
if public-facing code or CLI behavior changes. Test coverage
30+
should be maintained at 100%, and all lints should be obeyed.
31+
32+
Please specifically note if you want to use "# noqa",
33+
"# pragma: no cover", or similar flags/settings to disable
34+
any coverage/linting.
35+
-->
36+
37+
- [ ] Documentation
38+
- [ ] Tests
39+
- [ ] CHANGELOG
40+

‎.github/workflows/ci_tests.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: ci-tests
2+
3+
on: push
4+
5+
jobs:
6+
all_checks:
7+
name: Run all tests, lints, etc. (Python 3.9)
8+
runs-on: ubuntu-latest
9+
if: "!contains(github.event.head_commit.message, '[skip ci]')"
10+
11+
steps:
12+
- name: Check out repo
13+
uses: actions/checkout@v2
14+
15+
- name: Install Python
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: 3.9
19+
20+
- name: Update pip & setuptools
21+
run: python -m pip install -U pip setuptools
22+
23+
- name: Install & report CI dependencies
24+
run: |
25+
python -m pip install -U --force-reinstall -r requirements-ci.txt -r requirements-flake8.txt
26+
python --version
27+
pip list
28+
29+
- name: Build docs
30+
run: |
31+
cd doc
32+
make html
33+
mkdir scratch
34+
35+
- name: Run tests
36+
run: |
37+
pytest --cov=src --testall --nonloc
38+
tox -e sdist_install
39+
40+
- name: Run doctests
41+
run: |
42+
cd doc
43+
make doctest
44+
45+
- name: Run docs link check
46+
run: |
47+
cd doc
48+
make linkcheck
49+
50+
- name: Lint code
51+
run: tox -e flake8
52+
53+
- name: Transmit to Codecov
54+
run: codecov
55+
56+
57+
just_tests:
58+
name: Run only the test suite
59+
runs-on: ubuntu-latest
60+
strategy:
61+
matrix:
62+
python: ['3.6', '3.7', '3.8']
63+
if: "!contains(github.event.head_commit.message, '[skip ci]')"
64+
65+
steps:
66+
- name: Check out repo
67+
uses: actions/checkout@v2
68+
69+
- name: Install Python
70+
uses: actions/setup-python@v2
71+
with:
72+
python-version: ${{ matrix.python }}
73+
74+
- name: Update pip & setuptools
75+
run: python -m pip install -U pip setuptools
76+
77+
- name: Install & report CI dependencies
78+
run: |
79+
python -m pip install -U --force-reinstall -r requirements-ci.txt
80+
python --version
81+
pip list
82+
83+
- name: Build docs
84+
run: |
85+
cd doc
86+
make html
87+
mkdir scratch
88+
89+
- name: Run tests
90+
run: |
91+
pytest --cov=src --testall --nonloc
92+
tox -e sdist_install
93+

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,6 @@ doc/scratch/*
7878
# Mutmut
7979
.mutmut-cache
8080

81+
# VS Code
82+
.vscode
83+

‎.readthedocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ formats: all
1414

1515
# Python and requirements
1616
python:
17-
version: 3.7
17+
version: 3.8
1818
install:
1919
- requirements: requirements-rtd.txt
2020
- method: pip

‎.travis.yml‎

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

‎AUTHORS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ As I started to use it regularly in my own documentation work, it became clear t
1616
from also implementing functionality to assist with object searches, especially in large documentation sets.
1717
Also, it seemed likely that a robust API for creation/manipulation of inventory contents would be useful, in order to
1818
assist with things like scraping a non-Sphinx website to generate an objects.inv for cross-referencing in other docs.
19-
This led to the current object-oriented API of `sphobjinv` v2.0.
19+
This led to the current object-oriented API of `sphobjinv` v2.x.
2020

21-
While there are [a number](https://github.com/bskinn/sphobjinv/issues) of possible enhancements to the project,
21+
While there are [numerous](https://github.com/bskinn/sphobjinv/issues) possible enhancements to the project,
2222
I'm quite satisfied with its ease of use and usefulness, at least for my purposes, and thus consider it fully stable.
2323
I'm always glad to receive feature requests and (especially) bug reports, though.

0 commit comments

Comments
 (0)