sphinx_inv

A rust library to parse Sphinx objects.inv files

(Currently mostly for shits and giggles, but who knows.)

Dev tools

To develop sphinx_inv you'll want to have these tools installed:

• just A command runner to run (and document) workflows we run, including installing dev and publish dependencies
• typos-cli Fixing typos... not that we make any... but you know, just in case.
• taplo-cli Keeping our .toml files nice and clean
• bacon A runner that will watch your files and run checks, tests, linting etc. when they change. Very useful while developing

Publishing Tools

If you have to publish, or otherwise fiddle with dependencies of sphinx_inv you'll want these installed as well:

• cargo-semver A cargo plugin to check that we haven't accidentally broken our API when we didn't mean to.
• cargo-edit A cargo plugin for managing dependencies, incl updating them.
• git-cliff A neat tool to generate our changelog

Template

This repo was initially setup using cargo-generate and this template