Merge pull request #197 from bskinn/release-2.1

Merge to stable for v2.1 release

.gitattributes

@@ -0,0 +1,2 @@
+tests/resource/objects_mkdoc_zlib0.inv binary
+

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,56 @@
+---
+name: Bug Report
+about: Create a bug report to help improve the project
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Brief description**
+<!-- Clear and concise description of the bug. -->
+
+**Expected behavior**
+<!-- Description of what you expected to happen. -->
+
+**Actual behavior**
+<!-- Description of what actually happened. -->
+
+**To reproduce**
+<!--
+  Steps to reproduce the behavior:
+  1. Open '...'
+  2. Type '...'
+  3. See error
+-->
+
+**Attachments**
+<!--
+  If possible, please paste in an inventory file that
+  demonstrates the bug, or provide a link to a relevant
+  inventory on web.
+
+  If relevant, paste in screenshot(s) demonstrating
+  the bug.
+-->
+
+**System information**
+ - Device: 
+ - OS:
+
+**Python environment**
+
+*Python*
+<!--
+  Please paste the output of `$ {python} --version --version`
+  executed in the relvant environment.
+-->
+
+*Libraries*
+<!--
+  Please paste the output of `$ pip list` or `$ pip freeze`
+  executed in the relevant environment.
+--> 
+
+**Additional information**
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+<!-- A clear and concise description of what the problem is. E.g., I'm always frustrated when [...] -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
+
+**Additional context**
+<!--
+  Add any other context or screenshots about the feature request here. If there's a
+  specific inventory file that helps demonstrate the behavior you want, attach it here.
+-->

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+<!-- THANKS FOR YOUR CONTRIBUTION!! -->
+
+**Is the PR a fix or a feature?**
+<!-- Please indicate the type of change the PR will make. -->
+
+**Describe the changes in the PR**
+<!--
+  Whatever level of detail is necessary to describe the changes well.
+  A simple reference to associated issue(s) may suffice here
+  (e.g., "Closes #113"), if the description/discussion there is
+  complete enough.
+-->
+
+**Does this PR close any issues?**
+<!--
+  If not indicated in the above PR description, indicate here
+  which issue(s) are closed by the PR, if any; e.g.:
+
+  Closes #112 and closes #117.
+
+  Please use a separate 'closes' with each issue number,
+  to be sure that Github links the PR correctly to each closed issue.
+-->
+
+**Does the PR change/update the following, if relevant?**
+<!--
+  All changes to code, even internal-only changes, should have
+  a CHANGELOG entry. Documentation changes are usually only required
+  if public-facing code or CLI behavior changes. Test coverage
+  should be maintained at 100%, and all lints should be obeyed.
+
+  Please specifically note if you want to use "# noqa",
+  "# pragma: no cover", or similar flags/settings to disable
+  any coverage/linting.
+-->
+
+- [ ] Documentation
+- [ ] Tests
+- [ ] CHANGELOG
+

.github/workflows/ci_tests.yml

@@ -0,0 +1,93 @@
+name: ci-tests
+
+on: push
+
+jobs:
+  all_checks:
+    name: Run all tests, lints, etc. (Python 3.9)
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v2
+
+    - name: Install Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: Update pip & setuptools
+      run: python -m pip install -U pip setuptools
+
+    - name: Install & report CI dependencies
+      run: |
+        python -m pip install -U --force-reinstall -r requirements-ci.txt -r requirements-flake8.txt
+        python --version
+        pip list
+
+    - name: Build docs
+      run: |
+        cd doc
+        make html
+        mkdir scratch
+
+    - name: Run tests
+      run: |
+        pytest --cov=src --testall --nonloc
+        tox -e sdist_install
+
+    - name: Run doctests
+      run: |
+        cd doc
+        make doctest
+
+    - name: Run docs link check
+      run: |
+        cd doc
+        make linkcheck
+
+    - name: Lint code
+      run: tox -e flake8
+
+    - name: Transmit to Codecov
+      run: codecov
+
+
+  just_tests:
+    name: Run only the test suite
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ['3.6', '3.7', '3.8']
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v2
+
+    - name: Install Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+
+    - name: Update pip & setuptools
+      run: python -m pip install -U pip setuptools
+
+    - name: Install & report CI dependencies
+      run: |
+        python -m pip install -U --force-reinstall -r requirements-ci.txt
+        python --version
+        pip list
+
+    - name: Build docs
+      run: |
+        cd doc
+        make html
+        mkdir scratch
+
+    - name: Run tests
+      run: |
+        pytest --cov=src --testall --nonloc
+        tox -e sdist_install
+      

.gitignore

@@ -78,3 +78,6 @@ doc/scratch/*
 # Mutmut
 .mutmut-cache
 
+# VS Code
+.vscode
+

.readthedocs.yml

@@ -14,7 +14,7 @@ formats: all
 
 # Python and requirements
 python:
-  version: 3.7
+  version: 3.8
   install:
     - requirements: requirements-rtd.txt
     - method: pip

AUTHORS.md

@@ -16,8 +16,8 @@ As I started to use it regularly in my own documentation work, it became clear t
 from also implementing functionality to assist with object searches, especially in large documentation sets.
 Also, it seemed likely that a robust API for creation/manipulation of inventory contents would be useful, in order to
 assist with things like scraping a non-Sphinx website to generate an objects.inv for cross-referencing in other docs.
-This led to the current object-oriented API of `sphobjinv` v2.0.
+This led to the current object-oriented API of `sphobjinv` v2.x.
 
-While there are [a number](https://github.com/bskinn/sphobjinv/issues) of possible enhancements to the project,
+While there are [numerous](https://github.com/bskinn/sphobjinv/issues) possible enhancements to the project,
 I'm quite satisfied with its ease of use and usefulness, at least for my purposes, and thus consider it fully stable.
 I'm always glad to receive feature requests and (especially) bug reports, though.