Linksmith

A program for processing Hyperlinks, Sphinx references, and inventories.

Longing for a Hyperlink,
already in hand.
MEP 0002,
considering.

» Documentation | Changelog | PyPI | Issues | Source code | License

What's Inside

• A few convenience wrappers around sphinx.ext.intersphinx and sphobjinv.
• Ideas to support DWIM-like tooling for Sphinx and Hyperlinks, coming from a sweet conversation at pueblo's sketch about adding an inventory decoder for Sphinx, summarized into a feature wish list.
• Code for community operations, alongside software tests and packaging, in order to provide better maintainability and re-use.

Warning

Here be dragons. Please note the program is pre-alpha, and a work in progress, so everything may change while we go.

Setup

pip install --upgrade linksmith

Usage

linksmith inventory https://linksmith.readthedocs.io/en/latest/objects.inv

More details and other subsystems are outlined at the Linksmith Usage documentation.

Development

In order to learn how to set up a development sandbox, please visit the development documentation.

Contributing

We are always happy to receive code contributions, ideas, suggestions and problem reports from the community.

Spend some time taking a look around, locate a bug, design issue or spelling mistake and then send us a pull request or create an issue ticket.

Thanks in advance for your efforts, we really appreciate any help or feedback.

Acknowledgements

Kudos to Brian Skinn, Sviatoslav Sydorenko, Chris Sewell, and all other lovely people around Sphinx and Read the Docs.

Etymology

Anansi, or Ananse (/əˈnɑːnsi/ ə-NAHN-see) is an Akan folktale character associated with stories, wisdom, knowledge, and trickery.

Anansi is best known for his ability to outsmart and triumph over more powerful opponents through his use of cunning, creativity and wit.

Despite taking on a trickster role, Anansi often takes centre stage in stories and is commonly portrayed as both the protagonist and antagonist.

-- https://en.wikipedia.org/wiki/Anansi

Another anansi package has already been published to PyPI, so we needed to find a different name, and selected linksmith for the time being. If you have other suggestions as long as this program is in its infancy, please let us know.