|
1 | 1 | Credits
|
2 | 2 | =======
|
3 | 3 |
|
4 |
| -`sphobjinv` is authored and maintained by Brian Skinn ([Blog](https://bskinn.github.io)) ([Twitter](https://twitter.com/btskinn)). |
| 4 | +`sphobjinv` is authored and maintained by Brian Skinn |
| 5 | +([Blog](https://bskinn.github.io)) ([Twitter](https://twitter.com/btskinn)). |
5 | 6 |
|
6 |
| -The idea for the project came about as I was starting to deepen my expertise with Sphinx, and found it |
7 |
| -hugely frustrating to debug cross-references to objects in code. I discovered the `objects.inv` files |
8 |
| -relatively quickly, but struggled with trying to get at the actual object information. |
9 |
| -At the time (2016), the ability to [execute `sphinx.ext.intersphinx` as a module](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#showing-all-links-of-an-intersphinx-mapping-file) |
10 |
| -hadn't yet been documented (that happened in [2018](https://github.com/sphinx-doc/sphinx/commit/7aaba1758a4622298d15339fddd8556eb221af86)), |
11 |
| -and a fair bit of searching didn't turn up anything promising. |
| 7 | +The idea for the project came about as I was starting to deepen my expertise |
| 8 | +with Sphinx, and found it hugely frustrating to debug cross-references to |
| 9 | +objects in code. I discovered the `objects.inv` files relatively quickly, but |
| 10 | +struggled with trying to get at the actual object information. At the time |
| 11 | +(2016), the ability to |
| 12 | +[execute `sphinx.ext.intersphinx` as a module](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#showing-all-links-of-an-intersphinx-mapping-file) |
| 13 | +hadn't yet been documented (that happened in |
| 14 | +[2018](https://github.com/sphinx-doc/sphinx/commit/7aaba1758a4622298d15339fddd8556eb221af86)), |
| 15 | +and a fair bit of searching didn't turn up anything promising. |
12 | 16 |
|
13 |
| -Once I dug into the Sphinx code to figure out how to zlib-decompress the object data, it was relatively straightforward |
14 |
| -to put together the initial v1.0 of `sphobjinv`, which could only (de)compress `objects.inv` files to/from plaintext. |
15 |
| -As I started to use it regularly in my own documentation work, it became clear that there would be significant advantages |
16 |
| -from also implementing functionality to assist with object searches, especially in large documentation sets. |
17 |
| -Also, it seemed likely that a robust API for creation/manipulation of inventory contents would be useful, in order to |
18 |
| -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.x. |
| 17 | +Once I dug into the Sphinx code to figure out how to zlib-decompress the object |
| 18 | +data, it was relatively straightforward to put together the initial v1.0 of |
| 19 | +`sphobjinv`, which could only (de)compress `objects.inv` files to/from |
| 20 | +plaintext. As I started to use it regularly in my own documentation work, it |
| 21 | +became clear that there would be significant advantages to also implement object |
| 22 | +searches, especially in large documentation sets. Also, it seemed likely that a |
| 23 | +robust API for creation/manipulation of inventory contents would be useful, in |
| 24 | +order to assist with things like scraping a non-Sphinx website to generate an |
| 25 | +`objects.inv` for cross-referencing in other docs. This led to the current |
| 26 | +object-oriented API of `sphobjinv` v2.x. |
20 | 27 |
|
21 |
| -While there are [numerous](https://github.com/bskinn/sphobjinv/issues) possible enhancements to the project, |
22 |
| -I'm quite satisfied with its ease of use and usefulness, at least for my purposes, and thus consider it fully stable. |
23 |
| -I'm always glad to receive feature requests and bug reports, though. |
| 28 | +While there are [numerous](https://github.com/bskinn/sphobjinv/issues) possible |
| 29 | +enhancements to the project, I'm quite satisfied with its ease of use and |
| 30 | +usefulness, at least for my purposes, and thus consider it fully stable. I'm |
| 31 | +always glad to receive feature requests and bug reports, though. |
0 commit comments