Skip to content

Commit

Permalink
Merge pull request #215 from bskinn/release-2.2b1
Browse files Browse the repository at this point in the history
Merge for v2.2b1 release
  • Loading branch information
bskinn authored Dec 23, 2021
2 parents 9c23522 + bca7cf3 commit daff108
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
omit =
# Don't cover code in the env (just in case)
env/*

# Don't worry about covering vendored libraries
src/sphobjinv/_vendored/*

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/ci_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,3 @@ jobs:
run: |
pytest --cov=src --testall --nonloc
tox -e sdist_install
4 changes: 2 additions & 2 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ hadn't yet been documented (that happened in [2018](https://github.com/sphinx-do
and a fair bit of searching didn't turn up anything promising.

Once I dug into the Sphinx code to figure out how to zlib-decompress the object data, it was relatively straightforward
to put together the initial v1.0 of `sphobjinv`, which could only (de)compress objects.inv files to/from plaintext.
to put together the initial v1.0 of `sphobjinv`, which could only (de)compress `objects.inv` files to/from plaintext.
As I started to use it regularly in my own documentation work, it became clear that there would be significant advantages
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.
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.x.

While there are [numerous](https://github.com/bskinn/sphobjinv/issues) possible enhancements to the project,
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and this project strives to adhere to
[Semantic Versioning](http://semver.org/spec/v2.0.0.html).


### [2.2b1] - *pending*
### [2.2b1] - 2021-12-23

#### Removed

Expand Down
2 changes: 1 addition & 1 deletion requirements-ci.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
attrs>=17.4
attrs>=19.2
certifi
codecov
coverage
Expand Down
3 changes: 2 additions & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
attrs>=17.4
attrs>=19.2
build
certifi
coverage
dictdiffer
Expand Down
2 changes: 1 addition & 1 deletion requirements-rtd.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
attrs>=17.4
attrs>=19.2
sphinx==4.3.1
sphinx-issues
sphinx-rtd-theme
Expand Down
4 changes: 4 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ classifiers =
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11
Topic :: Documentation
Topic :: Documentation :: Sphinx
Topic :: Software Development
Topic :: Software Development :: Documentation
Topic :: Utilities
Development Status :: 5 - Production/Stable
keywords = sphinx, sphinx-doc, inventory, manager, inspector
Expand Down
2 changes: 1 addition & 1 deletion src/sphobjinv/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
"""

__version__ = "2.2b1.dev0"
__version__ = "2.2b1"

0 comments on commit daff108

Please sign in to comment.