Changes between Version 2 and Version 3 of building_the_docs


Ignore:
Timestamp:
28 Dec 2017 11:46:50 (14 months ago)
Author:
bakaniko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • building_the_docs

    v2 v3  
    175175The first thing that CMake does is to check if you are in the folder called {{{build}}}. If it is not the case, CMake will return an error.
    176176
    177 <pre class="{bash}">if ( ${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR} )
     177{{{if ( ${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR} )
    178178message(FATAL_ERROR "In-source builds not allowed.
    179179Please make a new directory (called a build directory) and run CMake from there.
    180180You may need to remove CMakeCache.txt." )
    181 endif()</pre>
     181endif()}}}
    182182==== Changing the version number ====
    183183
    184184In {{{CMakeLists.txt}}}, you can change the OSGeo-Live version number with the following variables:
    185185
    186 <pre class="{bash}">## Major version
     186{{{## Major version
    187187set(OSGeoLiveDoc_VERSION_MAJOR "12")
    188188
     
    194194
    195195## if it is a development version, a Release Candidate or a final release
    196 set(OSGeoLiveDoc_VERSION_DEV "-dev")</pre>
     196set(OSGeoLiveDoc_VERSION_DEV "-dev")}}}
    197197==== Checking the sphinx version ====
    198198
     
    317317In CMakeLists.txt they are set like that:
    318318
    319 <pre class="{bash}">#---------------------
     319{{{#---------------------
    320320# Files
    321321#---------------------
     
    350350"overview"
    351351"standards"
    352 )</pre>
     352)}}}
    353353So commented out or deleted lines won't be taken in account, and won't be translated. If you comment "overview", the overviews won't be built.
    354354