Changes between Version 3 and Version 4 of building_the_docs


Ignore:
Timestamp:
28 Dec 2017 11:48:15 (18 months ago)
Author:
bakaniko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • building_the_docs

    v3 v4  
    3636On {{{ubuntu 16.04}}}
    3737
    38 <source lang="bash">sudo apt install cmake git
    39 
    40 sudo pip install sphinx</source>
     38{{{sudo apt install cmake git
     39
     40sudo pip install sphinx}}}
    4141== Preparing the repository ==
    4242
     
    5151This build will only make the English version and will be faster so you can quickly visualize your changes.
    5252
    53 <source lang="bash">## making the build folder (where builds will be put)
     53{{{## making the build folder (where builds will be put)
    5454mkdir build
    5555
     
    6262# Build html files
    6363make html
    64 </source>
     64}}}
    6565And you're done ! You can go to {{{build/doc/_build/}}} and open {{{index.html}}} in a web browser.
    6666
     
    211211Add the 2 letters code of the new language:
    212212
    213 <source lang="bash">set(OSGeoLiveDoc_SUPPORTED_LANGUAGES "ca"  "de"  "es"  "fr"  "it"  "ja"  "ko"  "pl"  "ru")</source>
     213{{{set(OSGeoLiveDoc_SUPPORTED_LANGUAGES "ca"  "de"  "es"  "fr"  "it"  "ja"  "ko"  "pl"  "ru")}}}
    214214Then add a new {{{INSERT_INTO_MAP}}} command to add the language to the lang navigation bar (in {{{index.html}}}). For example:
    215215
     
    423423This 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.
    424424
    425 <source lang="perl">my $configuration = read_and_parse_configuration($projects_info_file);</source>
     425{{{my $configuration = read_and_parse_configuration($projects_info_file);}}}
    426426==== read_and_parse_configuration subroutine ====
    427427
     
    483483The variables are loaded by CMake during the build from data in {{{CMakeLists.txt}}}.
    484484
    485 <source lang="perl">my $DEBUG = "@OSGeoLiveDoc_DEBUG@";
     485{{{my $DEBUG = "@OSGeoLiveDoc_DEBUG@";
    486486my $version = "@OSGeoLiveDoc_VERSION@";
    487487my $projects_info_file = '@CMAKE_SOURCE_DIR@/projects_info.csv';
    488 my $output_file = '@CMAKE_CURRENT_BINARY_DIR@/../metrics.rst';</source>
     488my $output_file = '@CMAKE_CURRENT_BINARY_DIR@/../metrics.rst';}}}
    489489= Useful commands =
    490490
     
    493493==== Moving the files to the right folder ====
    494494
    495 <source lang="bash">git mv doc/images/projects/gvsigFOOOOOOOOOOOO doc/images/projects/gvsig
     495{{{git mv doc/images/projects/gvsigFOOOOOOOOOOOO doc/images/projects/gvsig
    496496
    497497# see the change
    498 git status</source>
     498git status}}}
    499499==== Changing all occurrences ====
    500500
     
    505505==== THE command: ====
    506506
    507 <source lang="bash">perl -pi -e "s/projects\/gvsigFOOOOOOOOOOOO/projects\/gvsig/" $(git ls-files)</source>
     507{{{perl -pi -e "s/projects\/gvsigFOOOOOOOOOOOO/projects\/gvsig/" $(git ls-files)}}}
    508508* {{{git ls-files}}} : lists the files that git knows about
    509509* {{{perl}}} <--- use that