Usage#
Linksmith provides the linksmith
command line program. It harbours
different subsystems, accessible by using corresponding subcommands,
like linksmith inventory
.
Warning
Here be dragons. Please note the program is pre-alpha, and a work in progress, so everything may change while we go.
Output Formats#
Display all the available output formats at a glance.
linksmith output-formats
Sphinx Inventories#
The linksmith inventory
subsystem supports working with Sphinx inventories,
it is heavily based on sphinx.ext.intersphinx
and sphobjinv
.
Single Inventory
Refer to objects.inv
on the local filesystem or on a remote location.
linksmith inventory /path/to/objects.inv
linksmith inventory https://linksmith.readthedocs.io/en/latest/objects.inv
linksmith inventory \
https://linksmith.readthedocs.io/en/latest/objects.inv \
--format=markdown+table
Multiple Inventories
Refer to multiple objects.inv
resources.
linksmith inventory \
https://github.com/crate/crate-docs/raw/main/registry/sphinx-inventories.txt \
--format=html+table
Auto-Discovery
Discover objects.inv
and conf.py
in working directory.
linksmith inventory
Favourite output format:
linksmith inventory --format=html+table > inventory.html
Anansi#
Suggest references from intersphinx inventories, derived from curated projects, RTD, or PyPI.
Synopsis
Run term suggestion on Sphinx documentation project, per its published objects.inv
file.
anansi suggest sarge capture
anansi suggest matplotlib draw
anansi suggest requests patch
anansi suggest beradio json
Display list of curated projects.
anansi list-projects