mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-22 14:52:41 +01:00
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
This commit is contained in:
parent
ee24eb60b7
commit
a58c9d50b2
1 changed files with 15 additions and 4 deletions
|
@ -3,17 +3,28 @@
|
|||
|
||||
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:
|
||||
|
||||
phabricator/ $ ./bin/diviner generate --book <book>
|
||||
|
||||
= .book Files =
|
||||
|
||||
Diviner ".book" Files
|
||||
=====================
|
||||
|
||||
Diviner documentation books are configured using JSON `.book` files, which
|
||||
look like this:
|
||||
|
|
Loading…
Reference in a new issue