Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/userguide/diviner.diviner
@title Diviner User Guide | @title Diviner User Guide | ||||
@group userguide | @group userguide | ||||
Using Diviner, a documentation generator. | Using Diviner, a documentation generator. | ||||
Overview | Overview | ||||
======== | ======== | ||||
Diviner is an application for creating technical documentation. | Diviner is an application for creating technical documentation. | ||||
This article is maintained in a text file in the Phabricator repository and | This article is maintained in a text file in the Phorge repository and | ||||
generated into the display document you are currently reading using Diviner. | generated into the display document you are currently reading using Diviner. | ||||
Beyond generating articles, Diviner can also analyze source code and generate | Beyond generating articles, Diviner can also analyze source code and generate | ||||
documentation about classes, methods, and other primitives. | documentation about classes, methods, and other primitives. | ||||
Generating Documentation | Generating Documentation | ||||
======================== | ======================== | ||||
To generate documentation, run: | To generate documentation, run: | ||||
phabricator/ $ ./bin/diviner generate --book <book> | phorge/ $ ./bin/diviner generate --book <book> | ||||
Diviner ".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: | ||||
▲ Show 20 Lines • Show All 64 Lines • Show Last 20 Lines |
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0