@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Slightly update the Diviner documentation
Summary: See PHI1050. Although Diviner hasn't received a ton of new development for a while, it's: not exaclty new; and pretty useful for what we need it for.
Test Plan: Reading.
Reviewers: amckinley
Reviewed By: amckinley
Subscribers: leoluk
Differential Revision: https://secure.phabricator.com/D20086
+15
-4
+15
-4
src/docs/user/userguide/diviner.diviner
+15
-4
src/docs/user/userguide/diviner.diviner
···
3
3
4
4
Using Diviner, a documentation generator.
5
5
6
-
= Overview =
6
+
Overview
7
+
========
8
+
9
+
Diviner is an application for creating technical documentation.
10
+
11
+
This article is maintained in a text file in the Phabricator repository and
12
+
generated into the display document you are currently reading using Diviner.
13
+
14
+
Beyond generating articles, Diviner can also analyze source code and generate
15
+
documentation about classes, methods, and other primitives.
7
16
8
-
NOTE: Diviner is new and not yet generally useful.
9
17
10
-
= Generating Documentation =
18
+
Generating Documentation
19
+
========================
11
20
12
21
To generate documentation, run:
13
22
14
23
phabricator/ $ ./bin/diviner generate --book <book>
15
24
16
-
= .book Files =
25
+
26
+
Diviner ".book" Files
27
+
=====================
17
28
18
29
Diviner documentation books are configured using JSON `.book` files, which
19
30
look like this: