archive/phabricator
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Slightly update the Diviner documentation

Browse Source 
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
This commit is contained in:
epriestley
2019-02-04 16:13:04 -08:00
parent ee24eb60b7
commit a58c9d50b2
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/docs/user/userguide/diviner.diviner
View File

@@ -3,17 +3,28 @@
Using Diviner, a documentation generator. Using Diviner, a documentation generator.
= Overview = Overview
========
NOTE: Diviner is new and not yet generally useful. Diviner is an application for creating technical documentation.
= Generating Documentation = This article is maintained in a text file in the Phabricator repository and
generated into the display document you are currently reading using Diviner.
Beyond generating articles, Diviner can also analyze source code and generate
documentation about classes, methods, and other primitives.
Generating Documentation
========================
To generate documentation, run: To generate documentation, run:
phabricator/ $ ./bin/diviner generate --book <book> phabricator/ $ ./bin/diviner generate --book <book>
= .book Files =
Diviner ".book" Files
=====================
Diviner documentation books are configured using JSON `.book` files, which Diviner documentation books are configured using JSON `.book` files, which
look like this: look like this: