mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation on how to generate the html and pdf docs with CMake.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10764 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2015-06-17 12:25:36 +00:00
parent c4c7767fd8
commit 33e589b22f
1 changed files with 43 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
documentation/README
View File

@ -1,7 +1,7 @@
README (documentation)
----------------------
FLTK 1.3 documentation is available in HTML and PDF format. The
documentation must be generated in a separate step or downloaded
FLTK 1.3 (and higher) documentation is available in HTML and PDF format.
The documentation must be generated in a separate step or downloaded
from FLTK's software download pages. The documentation can also
be accessed online.
@ -39,28 +39,63 @@ Extract the documentation tarballs into the same directory as you
did with the source tarball.
Generation of Documentation:
----------------------------
Generation of Documentation (common part):
------------------------------------------
To generate the documentation yourself, you should have Doxygen
version 1.5.7 or later (recommended version is 1.7.3).
version 1.5.7 or later (recommended version is 1.7.3 or later).
To generate the PDF version you also need a current version of LaTeX.
You can use the packages tetex (older) or texlive (current) if your
distribution provides them. You may need to install additional fonts
and other sub-packages for the PDF version to be generated correctly.
Generation of Documentation with autoconf (configure) + make:
-------------------------------------------------------------
Use "make html" in the documentation directory to generate the HTML
documentation, or "make pdf" to generate the PDF version. "make dist"
documentation, or "make pdf" to generate the PDF version. "make docs"
generates both versions in one step (as would do "make clean html pdf").
To read the HTML or PDF docs, see above.
Generation of Documentation with CMake + make:
----------------------------------------------
We assume that you use an out-of-source build as recommended.
Documentation is not generated in a default build. You must set one or
more CMake options using cmake-gui, ccmake, or cmake -DOPTION...
These options are predefined to OFF and can be switched ON:
- OPTION_BUILD_HTML_DOCUMENTATION:BOOL=OFF target: html
- OPTION_BUILD_PDF_DOCUMENTATION:BOOL=OFF target: pdf
- OPTION_INSTALL_HTML_DOCUMENTATION:BOOL=OFF
- OPTION_INSTALL_PDF_DOCUMENTATION:BOOL=OFF
If you switch one or both of the first two options ON, then the
targets 'html' and/or 'pdf' are generated, respectively. Target 'docs'
is added to generate both 'html' and 'pdf'. As said above, you need
installed Doxygen and LaTeX software for this to work.
Use "make html" in the root or documentation directory of the build tree
to generate the HTML documentation, or "make pdf" to generate the PDF
version. "make docs" generates both versions in one step (as would do
"make clean html pdf").
To read the HTML or PDF docs, see above, but use the build directory.
Note: if you enable one or more of the "*INSTALL*" options, then
`make install' will install the docs, but you must still build them
manually, because the generation is not included in the standard ('all')
target. This may be changed in the future.
FLTK Developer Snapshots or Subversion Usage:
---------------------------------------------
There is no pre-generated documentation available if you use a current
developer snapshot or subversion. You must generate the documentation
yourself.
yourself or access the online documentation.
Bugs and Feature Requests: