From 33dcb353441b5fc0bc39d98314b8930a512be416 Mon Sep 17 00:00:00 2001 From: Pierre Goiffon Date: Tue, 6 Apr 2021 18:17:41 +0200 Subject: [PATCH] :memo: .doc/README : fix generation procedure --- .doc/README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/.doc/README.md b/.doc/README.md index e6c294bc1..fb56f5f16 100644 --- a/.doc/README.md +++ b/.doc/README.md @@ -77,24 +77,20 @@ Then, **for a method** of an eligible class: :notebook: as spaces are used to mark code, the templates (`.doc/phpdoc-templates/combodo-wiki/*`) have very few indentation, thus they are awful to read (sorry). - - - ## Installation + ``` cd .doc composer require phpdocumentor/phpdocumentor:~2 --dev ``` ## Generation -`./bin/build-doc-object-manipulation` and `./bin/build-doc-extensions` contains examples of doc. generation, beware: they have to be called from the .doc directory: -```shell -cd /path/to/itop/.doc -./bin/build-doc-object-manipulation -``` - -the resulting documentation is written into `data/phpdocumentor/output` +1. Switch to this directory : `cd /path/to/itop/.doc` +2. `composer install` +3. `./bin/build-doc-object-manipulation` +3. `./bin/build-doc-extensions` +4. Get the generated files from `/path/to/itop/data/phpdocumentor/output` ## Dokuwiki requirements * the template uses the [wrap plugin](https://www.dokuwiki.org/plugin:wrap).