Glossary
- application_root
Configuration option. Absolute path to the source directory, usually indicated with names like src or application.
see also
- api_directory
Configuration option. Absolute path to the directory for api-documentation. doc2rst will populate this directory with generated rst-files.
see also
- bootstrap_file
Configuration option. File needed to be able to load your classes. When using composer can be as simple as
<?php require_once "path/to/your/vendor/autoload.php";
- d2r-conf.php
Configuration file. This file, with suggestions for configuration, will be placed in the doc_root directory after running ProcessManager::quickStart.
see also
RC for detailed information about configuration options.- d2r-order.php
Configuration file. This file, with suggestions for configuration, will be placed in the doc_root directory after running ProcessManager::quickStart.
- d2r-styles.txt
Configuration file. This file holds some style information and will be ingested at the top of each generated rst-document. It will be placed in the doc_root directory after running ProcessManager::quickStart.
- doc2rst.phar
Executable phar-file. Convenient way to generate reStructuredText files for your project documentation. Download doc2rst.phar from github releases. Install preferably in your project root folder. On a commandline execute
$ ./doc2rst.phar -h
for help on options and arguments.
- doc_root
Configuration option. Absolute path to the directory for documentation aka docs.
see also
- package documentation page
For each directory encountered in the source tree a package documentation file will be generated. The contents of any package.rst file found in this directory will be integrated in the package documentation page. It further displays links to classes, php-files and/or packages found in this directory. If files, other than php-files, are made downloadable the package documentation page will have download links to these files.
- package.rst
File in a source directory in reStructuredText format. If such a file is encountered it will be included in the package documentation page. A package.rst file can be as simple as carrying one line: The summary of the package, describing in short the purpose of the package.
Hint
It is also possible to add individual files to the downloads section of the package documentation page. In order to accomplish this just add an entry
.. download {file_name}
on a new line to the package.rst file of that package.
- quickstart
Doc2rst run mode that initiates configuration files in the doc_root folder, scans the source tree and does best guesses for configuration options. In this mode doc2rst will not generate reStructuredText files. Run quickstart with doc2rst.phar in your project root folder:
$ ./doc2rst.phar -q ./docs
see also
- run
Doc2rst run mode wherein the actual work is done: generating documentation from your source tree. Run with doc2rst.phar in your project root folder:
$ ./doc2rst.phar -r ./docs
see also
- vendor_directory
Configuration option. Absolute path to the directory that is usually one directory further than the application_root or source directory.
see also