[ET Trac] [Einstein Toolkit] #1038: remove compiled documentation from Cactus repository
Einstein Toolkit
trac-noreply at einsteintoolkit.org
Mon Aug 13 10:14:55 CDT 2012
#1038: remove compiled documentation from Cactus repository
--------------------------+-------------------------------------------------
Reporter: rhaas | Owner:
Type: enhancement | Status: new
Priority: optional | Milestone:
Component: Cactus | Version:
Resolution: | Keywords: documentation
--------------------------+-------------------------------------------------
Comment (by hinder):
Frank: That version is not always updated when people modify the source.
If we had the docs hosted on the web site automatically updated, people
could still always read it from a URL, and additionally it would always be
guaranteed to be up to date.
Bruno: We would generate both the HTML and the PDF, as we currently have
on the web site. Searchability is important; we could investigate
providing an easy way to search the HTML version, for example by having a
custom google search box, or a javascript-based search index (similar to
what is available for the simfactory user guide).
Erik: In that case, you can build the docs using "make UserGuide", which
normally takes only a few seconds. It is usually considered bad form to
keep derived files in version control unless there is a compelling reason.
I don't see this as a compelling reason.
--
Ticket URL: <https://trac.einsteintoolkit.org/ticket/1038#comment:7>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit
More information about the Trac
mailing list