[INFRA-37] Define documentation infrastructure Created: 02/Jul/16 Updated: 21/Jul/18 |
|
| Status: | Open |
| Project: | Software Development Infrastructure |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Story | Priority: | Major |
| Reporter: | swinbank | Assignee: | hassan |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Story Points: | 4 |
| Epic Link: | drp-docs |
| Description |
|
Long term, we'd like to have a coherent place to find documentation. Maybe that's Doxygen, or Sphinx, or something different. Make a plan. |
| Comments |
| Comment by hassan [ 21/Jul/18 ] |
|
We are currently considering a combination of reStructuredText and LaTeX for documentation. The former can be made publicly visible via GitHub and ReadTheDocs, and the latter is a 'standard' for scientific documentation. Will investigate whether Doxygen has a role, but it would be better to reduce the official document formats to two, or one. |