| Ashwin Sridharan | fd9cc7a | 2019-04-03 16:47:02 -0400 | [diff] [blame] | 1 | |
| E. Scott Daniels | 392168d | 2019-11-06 15:12:38 -0500 | [diff] [blame] | 2 | Documentation for RMR. |
| Ashwin Sridharan | fd9cc7a | 2019-04-03 16:47:02 -0400 | [diff] [blame] | 3 | |
| E. Scott Daniels | 392168d | 2019-11-06 15:12:38 -0500 | [diff] [blame] | 4 | Most (all?) documentation for RMR is built from source ({X)fm, or other text |
| 5 | formatter source, not the RMR code) rather than hand editing the output |
| Ashwin Sridharan | fd9cc7a | 2019-04-03 16:47:02 -0400 | [diff] [blame] | 6 | (markdown/rst) files. This allows for more control over the output, a wider |
| 7 | variety of output types, and (most importantly) the generation of multiple |
| 8 | output from the same source (e.g. man pages can be rendered in troff which |
| 9 | the man command required, and also rendered as .rst or .md files which some |
| 10 | wikis prefer, and as PDF which can be easily distributed). |
| 11 | |
| 12 | Thus, there is a source file below this directory which has the document |
| E. Scott Daniels | 392168d | 2019-11-06 15:12:38 -0500 | [diff] [blame] | 13 | source. Directories are as follows: |
| 14 | |
| 15 | man Manual pages included with the development package |
| 16 | |
| 17 | rtd Source to generate the .rst files for the "read the docs" |
| 18 | repo scraper. |