| Title | No build procedure for manual |
| Status | closed |
| Priority | optional |
| Assigned user | Gareth Rees |
| Product | project |
| Organization | Ravenbrook |
| Description | The HTML version of the manual needs to be built. At the moment this must be done by hand, and this means that it's not easy for a new developer to make changes, and the build is error-prone. |
| Analysis | Prerequisites: install sphinx-doc, for example via MacPorts "port install py27-sphinx". Check that it's installed by running "which sphinx-build". Steps: $ cd master/manual $ make html $ p4 reconcile html/... $ p4 reopen -t +w html/... $ p4 submit html/... -d "Updated manual HTML" Add a step to the release build procedure for building the manual. Add suitable targets to the master/manual/Makefile for the extra steps, for reliability. |
| How found | manual_test |
| Evidence | Conversation with NB. |
| Created by | Gareth Rees |
| Created on | 2013-03-20 12:11:00 |
| Last modified by | Gareth Rees |
| Last modified on | 2013-03-20 19:51:55 |
| History | 2013-03-20 GDR Created. |
| Change | Effect | Date | User | Description |
|---|---|---|---|---|
| 181195 | closed | 2013-03-20 19:51:55 | Gareth Rees | Makefile rule for updating the HTML version of the manual. Release build procedure ensures that the HTML version of the manual is up to date. |