| E. Scott Daniels | 3a2533f | 2020-04-22 12:40:27 -0400 | [diff] [blame] | 1 | |
| 2 | This directory contains documentation source which generates |
| 3 | some (if not all) of the documentation that is put into the |
| 4 | directory scraped for RTD. One of the advantages of this |
| 5 | approach is that example code presented in the document is |
| 6 | pulled from the examples directory in the repo which avoids |
| 7 | a duplicate set of "code" in the document which is likely to |
| 8 | become out of date. |
| 9 | |
| 10 | The documents in the scraped directory (<repo-root>/docs) |
| 11 | can be created with the command 'make publish' executed |
| 12 | in the source (src) directory. |