Changes between Version 3 and Version 4 of building_the_docs

Timestamp:

28 Dec 2017, 11:48:15 (6 years ago)

Author:

bakaniko

Comment:

--

building_the_docs

@@ -36 +36 @@
 On {{{ubuntu 16.04}}}
 
-<source lang="bash">sudo apt install cmake git
-
-sudo pip install sphinx</source>
+{{{sudo apt install cmake git
+
+sudo pip install sphinx}}}
 == Preparing the repository ==
 
@@ -51 +51 @@
 This build will only make the English version and will be faster so you can quickly visualize your changes.
 
-<source lang="bash">## making the build folder (where builds will be put)
+{{{## making the build folder (where builds will be put)
 mkdir build
 
@@ -62 +62 @@
 # Build html files
 make html
-</source>
+}}}
 And you're done ! You can go to {{{build/doc/_build/}}} and open {{{index.html}}} in a web browser.
 
@@ -211 +211 @@
 Add the 2 letters code of the new language:
 
-<source lang="bash">set(OSGeoLiveDoc_SUPPORTED_LANGUAGES "ca"  "de"  "es"  "fr"  "it"  "ja"  "ko"  "pl"  "ru")</source>
+{{{set(OSGeoLiveDoc_SUPPORTED_LANGUAGES "ca"  "de"  "es"  "fr"  "it"  "ja"  "ko"  "pl"  "ru")}}}
 Then add a new {{{INSERT_INTO_MAP}}} command to add the language to the lang navigation bar (in {{{index.html}}}). For example:
 
@@ -423 +423 @@
 This line parse the projects_info file and stores it in {{{$configuration}}}. If the flag {{{-DOSGeoLiveDoc_DEBUG=ON}}} is used, then a comment line will be print.
 
-<source lang="perl">my $configuration = read_and_parse_configuration($projects_info_file);</source>
+{{{my $configuration = read_and_parse_configuration($projects_info_file);}}}
 ==== read_and_parse_configuration subroutine ====
 
@@ -483 +483 @@
 The variables are loaded by CMake during the build from data in {{{CMakeLists.txt}}}.
 
-<source lang="perl">my $DEBUG = "@OSGeoLiveDoc_DEBUG@";
+{{{my $DEBUG = "@OSGeoLiveDoc_DEBUG@";
 my $version = "@OSGeoLiveDoc_VERSION@";
 my $projects_info_file = '@CMAKE_SOURCE_DIR@/projects_info.csv';
-my $output_file = '@CMAKE_CURRENT_BINARY_DIR@/../metrics.rst';</source>
+my $output_file = '@CMAKE_CURRENT_BINARY_DIR@/../metrics.rst';}}}
 = Useful commands =
 
@@ -493 +493 @@
 ==== Moving the files to the right folder ====
 
-<source lang="bash">git mv doc/images/projects/gvsigFOOOOOOOOOOOO doc/images/projects/gvsig
+{{{git mv doc/images/projects/gvsigFOOOOOOOOOOOO doc/images/projects/gvsig
 
 # see the change
-git status</source>
+git status}}}
 ==== Changing all occurrences ====
 
@@ -505 +505 @@
 ==== THE command: ====
 
-<source lang="bash">perl -pi -e "s/projects\/gvsigFOOOOOOOOOOOO/projects\/gvsig/" $(git ls-files)</source>
+{{{perl -pi -e "s/projects\/gvsigFOOOOOOOOOOOO/projects\/gvsig/" $(git ls-files)}}}
 * {{{git ls-files}}} : lists the files that git knows about
 * {{{perl}}} <--- use that