New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation title, author, and other details #945
Conversation
This also includes the PDF manual, Qt help file, man pages, etc.
According to https://tex.stackexchange.com/q/13067/2951 utf8x should be avoided if possible. Also, define LaTeX for Unicode PRIME character, used in eqc doc pages.
Test status and coverage content should be shown for HTML. PDF documentation does not to self-reference itself.
From the 5.0.0 release notes:
I have so far avoided changing the project name in Sphinx from PROJ.4 to PROJ for that reason. We do include information on the proj-datumgrid packages as well, so the documentation is not limited to PROJ only. I realise this is mostly semantics and hardly anyone cares. Thoughts on this? Otherwise I think this looks fine. Having version number in the PDF file probably doesn't make sense for the auto-generated PDF but once the docs reach a more complete state it could be handy having documentation snapshots for each version on download.osgeo.org/proj/. For instance starting from version 6.0.0. |
Ah right, I knew the project would remain as PROJ.4, but I seem to have slipped that this was the same as Sphinx's Another idea is to modify |
The lines are a bit blurred here, I'll admit that. The way I view it is that proj4.org is the project website that contain information about the project itself, documentation for PROJ and to some extend the proj-datumgrid packages. I am working on a plan for a better structure on the docs as a whole. I'll try to get that done soon and put it in an issue so we can discusss it in more details. Let me know when you've reverted the PROJ.4 -> PROJ things and I'll merge this. |
No distinction is required between version and release. Disable default highlight_language (was effectively Python)
I've restored project to PROJ.4. Two other modifications that I've also done:
Any luck looking into creating symbolic links from proj.pdf to proj4.pdf? |
This should be as simple as adding the symlink to the |
There are a few commits here that do a few things:
project
. This is visible in a few places, such as the HTML documentation.proj.pdf
, which will break a few external links to that URL. (Is it possible to create a symbolic link athttps://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj4.pdf
?) Perhaps we may want to rename these PDF outputs with the version in the filename, e.g.proj-5.1.0.pdf
, or is that going to be difficult to maintain?Specific notes are tracked in each commit description.