smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

Make a makefile to build MISs after MGs #101

Open niazim3 opened 6 years ago

niazim3 commented 6 years ago

As mentioned in #61, the generated document makes it appear as if the links are broken from section 3 to the Module Guide (https://github.com/smiths/caseStudies/blob/0f4f403445fab607ae5b6d767fc19dd271a45a7f/CaseStudies/ssp/Documentation%20Files/MIS_SSP.tex#L157-L165).

@smiths Explained, however, that "The links are external, so the MG has to be compiled first. The MIS uses the xr (external reference) package:

https://www.sharelatex.com/learn/Kb/Cross_referencing_with_the_xr_package_in_ShareLaTeX

I asked the previous students to write a makefile that would ensure that all of the documentation is up to date, since there are dependencies between the files. I do not believe that anyone has written that script. For now, we'll just have to manually make sure to compile all of the documents when the xr package is in use."

Making a makefile that does this may be helpful in the future. (Unsure who to assign this to, so assigning myself for now...)