Skip to content

Commit 6a54b6e

Browse files
author
jef
committedMar 6, 2011
[FEATURE] documentation improvements
replace AUTHORS, CONTRIBUTORS, DONORS, SPONSORS and TRANSLATOR with t2t version in doc, run txt2tags within the build and install documentation. Optionally build and install api documentation git-svn-id: http://svn.osgeo.org/qgis/trunk/qgis@15348 c8812cc2-4d05-0410-92ff-de0c093fc19c
·
final-1_7_1final-1_7_0
1 parent 261ed74 commit 6a54b6e

File tree

12 files changed

+1747
-228
lines changed

12 files changed

+1747
-228
lines changed
 

‎AUTHORS

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎CMakeLists.txt

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ ENDIF (WITH_GRASS)
5757
# mapserver by us disabled default because it needs FastCGI (which is optional dependency)
5858
SET (WITH_MAPSERVER FALSE CACHE BOOL "Determines whether QGIS mapserver should be built")
5959

60+
# include doxygen documentation
61+
SET (WITH_APIDOC FALSE CACHE BOOL "Determines whether the QGIS API doxygen documentation should be built")
62+
6063
# try to configure and build POSTGRESQL support
6164
SET (WITH_POSTGRESQL TRUE CACHE BOOL "Determines whether POSTGRESQL support should be built")
6265
IF (WITH_POSTGRESQL)
@@ -320,13 +323,13 @@ ELSE (WIN32)
320323

321324
ELSE (APPLE)
322325
# UNIX
323-
SET (DEFAULT_BIN_SUBDIR bin)
324-
SET (DEFAULT_CGIBIN_SUBDIR bin)
325-
SET (DEFAULT_LIB_SUBDIR lib${LIB_SUFFIX})
326-
SET (DEFAULT_DATA_SUBDIR share/qgis)
327-
SET (DEFAULT_LIBEXEC_SUBDIR lib${LIB_SUFFIX}/qgis)
328-
SET (DEFAULT_PLUGIN_SUBDIR lib${LIB_SUFFIX}/qgis/plugins)
329-
SET (DEFAULT_INCLUDE_SUBDIR include/qgis)
326+
SET (DEFAULT_BIN_SUBDIR bin)
327+
SET (DEFAULT_CGIBIN_SUBDIR bin)
328+
SET (DEFAULT_LIB_SUBDIR lib${LIB_SUFFIX})
329+
SET (DEFAULT_DATA_SUBDIR share/qgis)
330+
SET (DEFAULT_LIBEXEC_SUBDIR lib${LIB_SUFFIX}/qgis)
331+
SET (DEFAULT_PLUGIN_SUBDIR lib${LIB_SUFFIX}/qgis/plugins)
332+
SET (DEFAULT_INCLUDE_SUBDIR include/qgis)
330333
ENDIF (APPLE)
331334

332335
ENDIF (WIN32)
@@ -508,17 +511,13 @@ IF (APPLE)
508511
SUBDIRS (mac)
509512
ENDIF (APPLE)
510513

511-
#############################################################
512-
# install stuff
513-
514-
INSTALL (FILES AUTHORS CONTRIBUTORS SPONSORS DONORS TRANSLATORS INSTALL CODING
515-
DESTINATION ${QGIS_DATA_DIR}/doc)
516-
517514
# manual page - makes sense only on unix systems
518515
IF (UNIX AND NOT APPLE)
519516
INSTALL (FILES qgis.1 DESTINATION ${QGIS_MANUAL_DIR}/man1)
520517
ENDIF (UNIX AND NOT APPLE)
521518

519+
INSTALL(FILES cmake/FindQGIS.cmake DESTINATION ${QGIS_DATA_DIR})
520+
522521
#############################################################
523522
# Uninstall stuff see: http://www.vtk.org/Wiki/CMake_FAQ
524523
CONFIGURE_FILE(

‎CONTRIBUTORS

Lines changed: 0 additions & 53 deletions
This file was deleted.

‎DONORS

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎SPONSORS

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎TRANSLATORS

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎cmake/Txt2Tags.cmake

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Macros for txt2tags
2+
# ~~~~~~~~~~~~~~~~~~~
3+
# Copyright (c) 2011, Juergen E. Fischer <jef at norbit dot de>
4+
# Redistribution and use is allowed according to the terms of the BSD license.
5+
# For details see the accompanying COPYING-CMAKE-SCRIPTS file.
6+
7+
# use txt2tags for .t2t files
8+
9+
# search for bison
10+
MACRO(FIND_TXT2TAGS)
11+
IF(NOT TXT2TAGS_EXECUTABLE)
12+
IF (MSVC)
13+
FIND_PROGRAM(TXT2TAGS_EXECUTABLE PATHS
14+
NAMES txt2tags.exe
15+
PATHS $ENV{LIB_DIR}/bin $ENV{PROGRAMFILES}/GnuWin32/bin
16+
)
17+
ELSE (MSVC)
18+
FIND_PROGRAM(TXT2TAGS_EXECUTABLE txt2tags)
19+
ENDIF (MSVC)
20+
IF (NOT TXT2TAGS_EXECUTABLE)
21+
MESSAGE(STATUS "txt2tags not found - disabled")
22+
ENDIF (NOT TXT2TAGS_EXECUTABLE)
23+
ENDIF(NOT TXT2TAGS_EXECUTABLE)
24+
ENDMACRO(FIND_TXT2TAGS)
25+
26+
MACRO(ADD_TXT2TAGS_FILES _sources)
27+
FIND_TXT2TAGS()
28+
29+
FOREACH (_current_FILE ${ARGN})
30+
GET_FILENAME_COMPONENT(_in ${_current_FILE} ABSOLUTE)
31+
GET_FILENAME_COMPONENT(_basename ${_current_FILE} NAME_WE)
32+
33+
SET(_out ${CMAKE_CURRENT_BINARY_DIR}/${_basename})
34+
35+
ADD_CUSTOM_COMMAND(
36+
OUTPUT ${_out}
37+
COMMAND ${TXT2TAGS_EXECUTABLE}
38+
ARGS -o${_out} -t txt ${_in}
39+
DEPENDS ${_in}
40+
COMMENT "Building ${_out} from ${_in}"
41+
)
42+
43+
ADD_CUSTOM_COMMAND(
44+
OUTPUT ${_out}.html
45+
COMMAND ${TXT2TAGS_EXECUTABLE}
46+
ARGS -o${_out}.html -t html ${_in}
47+
DEPENDS ${_in}
48+
COMMENT "Building ${_out}.html from ${_in}"
49+
)
50+
51+
SET(${_sources} ${${_sources}} ${_out} ${_out}.html)
52+
ENDFOREACH (_current_FILE)
53+
ENDMACRO(ADD_TXT2TAGS_FILES)

‎cmake_templates/Doxyfile.in

Lines changed: 1658 additions & 0 deletions
Large diffs are not rendered by default.

‎cmake_templates/qgsconfig.h.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,7 @@
3232

3333
#cmakedefine HAVE_PYTHON
3434

35+
#cmakedefine WITH_APIDOC
36+
3537
#endif
3638

‎doc/CMakeLists.txt

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
1+
INCLUDE(Txt2Tags)
2+
ADD_TXT2TAGS_FILES(QGIS_DOC_FILES INSTALL.t2t CODING.t2t AUTHORS.t2t CONTRIBUTORS.t2t SPONSORS.t2t DONORS.t2t TRANSLATORS.t2t)
3+
SET(QGIS_DOC_FILES ${QGIS_DOC_FILES} index.html favicon.ico qgisdoc.css)
14

2-
SET (DOC_FILES
3-
favicon.ico
4-
index.html
5-
qgisdoc.css
6-
)
5+
ADD_CUSTOM_TARGET (t2tdoc ALL DEPENDS ${QGIS_DOC_FILES})
76

8-
#SUBDIRS (images plugins install_guide)
7+
INSTALL(FILES ${QGIS_DOC_FILES} DESTINATION ${QGIS_DATA_DIR}/doc)
8+
INSTALL(FILES images/qgis_new_80pct.png DESTINATION ${QGIS_DATA_DIR}/doc/images)
99

10-
INSTALL(FILES ${DOC_FILES}
11-
DESTINATION ${QGIS_DATA_DIR}/doc)
10+
IF(WITH_APIDOC)
11+
FIND_PACKAGE(Doxygen)
12+
IF(DOXYGEN_FOUND)
13+
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
14+
ADD_CUSTOM_TARGET(apidoc ALL
15+
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
16+
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
17+
DEPENDS qgis_core qgis_gui qgis_analysis
18+
COMMENT "Generating API documentation" VERBATIM)
19+
INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/api/html/ DESTINATION ${QGIS_DATA_DIR}/doc/api)
20+
ELSE(DOXYGEN_FOUND)
21+
MESSAGE(STATUS "QGIS api documentation not built - Doxygen not found")
22+
ENDIF(DOXYGEN_FOUND)
23+
ENDIF(WITH_APIDOC)
1224

13-
INSTALL(FILES images/qgis_new_80pct.png
14-
DESTINATION ${QGIS_DATA_DIR}/doc/images)
25+
#SUBDIRS (images plugins install_guide)

‎doc/INSTALL.t2t

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ source directory.
8686

8787
%!include: osx.t2t
8888

89-
%!include: authors.t2t
89+
%!include: iauthors.t2t

‎doc/authors.t2t

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.