search

michael-hartmann / caps

The Casimir Effect in the plane-sphere geometry.
GNU General Public License v2.0
4 stars 1 forks source link

tex version of manual renamed #118

Closed gertingold closed 5 years ago

gertingold commented 5 years ago

So far, the tex output of the manual results in a file caps.pdf. However, in the docs directory, there exists a file manual.pdf. This should be made consistent. The present PR proposes to produce manual.pdf as output file. Of course, we could also decide to switch to caps.pdf in all places.

michael-hartmann commented 5 years ago

I agree with the idea.

There are two manuals: the programming API and the user manual. So, maybe we should call the user manual "user manual" and doxygen output "API documentation"?

gertingold commented 5 years ago

Do I understand your comment correctly, you have more the title of the documents in mind? I was referring to the file names but I agree that we could also improve on the titles of the documents. We could call the files manual.pdf or even usermanual.pdf and api.pdf and give them the titles which you proposed, i.e. in the end something lile CaPS user manual and CaPS API documentation. If you agree, I would prepare conf files accordingly.

michael-hartmann commented 5 years ago

I have both the titles and the file names in mind and I like your proposal:

Can you adjust the PR?

gertingold commented 5 years ago

The user manual is done including some improvements for the html output. With doxygen, I am not yet completely sure how to adjust things in the way you proposed.

michael-hartmann commented 5 years ago

I think this is fine. :+1: