MPS issue job003450

TitleNo build procedure for manual
Statusclosed
Priorityoptional
Assigned userGareth Rees
Productproject
OrganizationRavenbrook
DescriptionThe 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.
AnalysisPrerequisites: 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 foundmanual_test
EvidenceConversation with NB.
Created byGareth Rees
Created on2013-03-20 12:11:00
Last modified byGareth Rees
Last modified on2013-03-20 19:51:55
History2013-03-20 GDR Created.

Fixes

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.