Skip to content

Commit af7a5f1

Browse files
committed
Update documentation
1 parent c0fcf6c commit af7a5f1

File tree

3 files changed

+24
-25
lines changed

3 files changed

+24
-25
lines changed

docs/backlog.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Backlog
22

33
## Iteration +1
4-
- Unlock accessing intersphinx mappings in `conf.py`
5-
- Access remote `conf.py` at GitHub or HTTP
6-
- Add output flavor, like `--details=compact,full`.
4+
- Inventory: Access remote `conf.py` at GitHub or HTTP
5+
- Inventory: Unlock `omit_documents` option
6+
- Inventory+Anansi: Add output flavor, like `--details=compact,full`.
77
**Full details**, well, should display **full URLs**, ready for
88
navigational consumption (clicking).
9-
- Look into intersphinx-untangled.
10-
- More attractive JSON output.
9+
- Community: Look into intersphinx-untangled.
10+
- Inventory: More attractive JSON output.
1111
https://github.com/tech-writing/linksmith/pull/4#discussion_r1546863551
1212

1313
## Iteration +2
@@ -25,3 +25,4 @@
2525
- Anansi: Display list of curated inventories.
2626
- Anansi: Accept and delegate `threshold` parameter.
2727
- Process multiple objects.inv: Strictness
28+
- Inventory: Unlock accessing intersphinx mappings in `conf.py`

docs/index.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Linksmith
22

3-
A program for processing Hyperlinks, Sphinx references, and inventories.
3+
Linksmith is a program for processing Hyperlinks, Sphinx references,
4+
and inventories.
5+
46
It is heavily based on [`sphinx.ext.intersphinx`] and [sphobjinv], and
5-
intends to provide [DWIM]-like tooling for [Sphinx] and [Hyperlinks].
7+
intends to provide [DWIM]-like tooling for [Sphinx] references and
8+
[Hyperlinks].
69

710
::::::{grid} 1 3 3 3
811
:margin: 4 4 0 0
@@ -17,6 +20,14 @@ MEP 0002, \
1720
considering.
1821
::::
1922

23+
::::{grid-item-card} {material-outlined}`menu_book;1.5em` Usage
24+
:shadow: md
25+
:link: usage
26+
:link-type: ref
27+
Guidelines and examples how to use the `linksmith`
28+
and `anansi` command line programs.
29+
::::
30+
2031
::::{grid-item-card} {material-outlined}`group;1.5em` RFC
2132
:shadow: md
2233
:link: rfc
@@ -28,21 +39,6 @@ Just the proposal, nothing more.
2839
- [](#rfc-community-operations)
2940
::::
3041

31-
::::{grid-item}
32-
:::{card} Setup
33-
:margin: 0 2 0 0
34-
:link: setup
35-
:link-type: ref
36-
`pip install ...`
37-
:::
38-
:::{card} Usage
39-
:margin: 0 2 0 0
40-
:link: usage
41-
:link-type: ref
42-
`linksmith inventory ...`
43-
:::
44-
::::
45-
4642
::::::
4743

4844

@@ -71,7 +67,9 @@ Intrigued by MEP 0002? Enjoy reading [](inv:mep#meps/mep-0002).
7167
:::
7268

7369
:::{tip}
74-
In order to start hacking on Linksmith, please refer to the documentation
70+
Linksmith is a work-in-progress, and is still in its infancy, appreciating any
71+
contributions to satisfy community needs.
72+
In order to start contributing to Linksmith, please refer to the documentation
7573
page about how to set up a [](#development-sandbox).
7674
:::
7775

docs/sandbox.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ git clone https://github.com/tech-writing/linksmith
1515
cd linksmith
1616
python3 -m venv .venv
1717
source .venv/bin/activate
18-
pip install --editable=.[develop,docs,test]
18+
pip install --editable='.[develop,docs,test]'
1919
poe check
2020
```
2121

@@ -50,7 +50,7 @@ poe docs-autobuild
5050

5151
```shell
5252
# Install a few more prerequisites.
53-
pip install --editable=.[release]
53+
pip install --editable='.[release]'
5454

5555
# Designate a new version.
5656
git tag v0.1.0

0 commit comments

Comments
 (0)