diff --git a/docs/backlog.md b/docs/backlog.md index 7596cb4..b65d12f 100644 --- a/docs/backlog.md +++ b/docs/backlog.md @@ -1,13 +1,13 @@ # Backlog ## Iteration +1 -- Unlock accessing intersphinx mappings in `conf.py` -- Access remote `conf.py` at GitHub or HTTP -- Add output flavor, like `--details=compact,full`. +- Inventory: Access remote `conf.py` at GitHub or HTTP +- Inventory: Unlock `omit_documents` option +- Inventory+Anansi: Add output flavor, like `--details=compact,full`. **Full details**, well, should display **full URLs**, ready for navigational consumption (clicking). -- Look into intersphinx-untangled. -- More attractive JSON output. +- Community: Look into intersphinx-untangled. +- Inventory: More attractive JSON output. https://github.com/tech-writing/linksmith/pull/4#discussion_r1546863551 ## Iteration +2 @@ -25,3 +25,4 @@ - Anansi: Display list of curated inventories. - Anansi: Accept and delegate `threshold` parameter. - Process multiple objects.inv: Strictness +- Inventory: Unlock accessing intersphinx mappings in `conf.py` diff --git a/docs/index.md b/docs/index.md index 42a561d..6b40314 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,11 @@ # Linksmith -A program for processing Hyperlinks, Sphinx references, and inventories. +Linksmith is a program for processing Hyperlinks, Sphinx references, +and inventories. + It is heavily based on [`sphinx.ext.intersphinx`] and [sphobjinv], and -intends to provide [DWIM]-like tooling for [Sphinx] and [Hyperlinks]. +intends to provide [DWIM]-like tooling for [Sphinx] references and +[Hyperlinks]. ::::::{grid} 1 3 3 3 :margin: 4 4 0 0 @@ -17,6 +20,14 @@ MEP 0002, \ considering. :::: +::::{grid-item-card} {material-outlined}`menu_book;1.5em` Usage +:shadow: md +:link: usage +:link-type: ref +Guidelines and examples how to use the `linksmith` +and `anansi` command line programs. +:::: + ::::{grid-item-card} {material-outlined}`group;1.5em` RFC :shadow: md :link: rfc @@ -28,21 +39,6 @@ Just the proposal, nothing more. - [](#rfc-community-operations) :::: -::::{grid-item} -:::{card} Setup -:margin: 0 2 0 0 -:link: setup -:link-type: ref -`pip install ...` -::: -:::{card} Usage -:margin: 0 2 0 0 -:link: usage -:link-type: ref -`linksmith inventory ...` -::: -:::: - :::::: @@ -71,7 +67,9 @@ Intrigued by MEP 0002? Enjoy reading [](inv:mep#meps/mep-0002). ::: :::{tip} -In order to start hacking on Linksmith, please refer to the documentation +Linksmith is a work-in-progress, and is still in its infancy, appreciating any +contributions to satisfy community needs. +In order to start contributing to Linksmith, please refer to the documentation page about how to set up a [](#development-sandbox). ::: diff --git a/docs/sandbox.md b/docs/sandbox.md index 9f59aa9..6db7e17 100644 --- a/docs/sandbox.md +++ b/docs/sandbox.md @@ -15,7 +15,7 @@ git clone https://github.com/tech-writing/linksmith cd linksmith python3 -m venv .venv source .venv/bin/activate -pip install --editable=.[develop,docs,test] +pip install --editable='.[develop,docs,test]' poe check ``` @@ -50,7 +50,7 @@ poe docs-autobuild ```shell # Install a few more prerequisites. -pip install --editable=.[release] +pip install --editable='.[release]' # Designate a new version. git tag v0.1.0