1
1
# Linksmith
2
2
3
- A program for processing Hyperlinks, Sphinx references, and inventories.
3
+ Linksmith is a program for processing Hyperlinks, Sphinx references,
4
+ and inventories.
5
+
4
6
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] .
6
9
7
10
::::::{grid} 1 3 3 3
8
11
:margin: 4 4 0 0
@@ -17,6 +20,14 @@ MEP 0002, \
17
20
considering.
18
21
::::
19
22
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
+
20
31
::::{grid-item-card} {material-outlined}` group;1.5em ` RFC
21
32
:shadow: md
22
33
:link : rfc
@@ -28,21 +39,6 @@ Just the proposal, nothing more.
28
39
- [ ] ( #rfc-community-operations )
29
40
::::
30
41
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
-
46
42
::::::
47
43
48
44
@@ -71,7 +67,9 @@ Intrigued by MEP 0002? Enjoy reading [](inv:mep#meps/mep-0002).
71
67
:::
72
68
73
69
:::{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
75
73
page about how to set up a [ ] ( #development-sandbox ) .
76
74
:::
77
75
0 commit comments