From 133d289ad1d6d01898ce23a745fc4cf7769efdb9 Mon Sep 17 00:00:00 2001 From: epriestley Date: Wed, 5 Mar 2014 13:00:40 -0800 Subject: [PATCH] Generate a documentation book for Arcanist Summary: Ref T988. Not pretty or polished, but works fine. Test Plan: Generated the docs, made sure they were all there. Reviewers: chad, btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D8413 --- .divinerconfig | 22 ---------------------- src/docs/book/arcanist.book | 21 +++++++++++++++++++++ src/docs/notforusers.diviner | 8 -------- 3 files changed, 21 insertions(+), 30 deletions(-) delete mode 100644 .divinerconfig create mode 100644 src/docs/book/arcanist.book delete mode 100644 src/docs/notforusers.diviner diff --git a/.divinerconfig b/.divinerconfig deleted file mode 100644 index 17f75d88..00000000 --- a/.divinerconfig +++ /dev/null @@ -1,22 +0,0 @@ -{ - "name" : "Arcanist", - "src_link" : - "https://secure.phabricator.com/diffusion/ARC/browse/master/%f$%l", - "groups" : { - "notuser" : "HEY! THIS IS NOT USER DOCUMENTATION!", - "config" : "Setup & Configuration", - "workflow" : "Workflows", - "lint" : "Lint Integration", - "linter" : "Linters", - "unit" : "Unit Test Integration", - "unitrun" : "Unit Test Runners", - "diff" : "Diff and Changeset APIs", - "differential" : "Differential Integration", - "workingcopy" : "Working Copy APIs", - "testcase" : "Test Cases" - }, - "engines" : [ - ["DivinerArticleEngine", {}], - ["DivinerXHPEngine", {}] - ] -} diff --git a/src/docs/book/arcanist.book b/src/docs/book/arcanist.book new file mode 100644 index 00000000..650765ee --- /dev/null +++ b/src/docs/book/arcanist.book @@ -0,0 +1,21 @@ +{ + "name" : "arcanist", + "title" : "Arcanist Technical Documentation", + "short" : "Arcanist Tech Docs", + "preface" : "Technical documentation for developing Arcanist.", + "root" : "../../../", + "uri.source" : + "https://secure.phabricator.com/diffusion/ARC/browse/master/%f$%l", + "rules" : { + "(\\.php$)" : "DivinerPHPAtomizer", + "(\\.diviner$)" : "DivinerArticleAtomizer" + }, + "exclude" : [ + "(^externals/)", + "(^scripts/)", + "(^support/)", + "(^resources/)" + ], + "groups" : { + } +} diff --git a/src/docs/notforusers.diviner b/src/docs/notforusers.diviner deleted file mode 100644 index 093248e8..00000000 --- a/src/docs/notforusers.diviner +++ /dev/null @@ -1,8 +0,0 @@ -@title This Is Technical Documentation For Contributors, Not User Documentation -@group notuser - -This section of the documentation has technical information for developers -and contributors. - -For user documentation, see the -[[http://www.phabricator.com/docs/phabricator/ | Phabricator Documentation]].