kameleon-builder 2.1.3 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (185) hide show
  1. data/.editorconfig +0 -0
  2. data/.env +2 -6
  3. data/CHANGELOG.rst +74 -1
  4. data/Gemfile +20 -2
  5. data/README.rst +35 -25
  6. data/Thorfile +29 -0
  7. data/contrib/kameleon_bashrc.sh +61 -0
  8. data/contrib/polipo_env.sh +3 -2
  9. data/kameleon-builder.gemspec +3 -10
  10. data/lib/kameleon.rb +10 -14
  11. data/lib/kameleon/cli.rb +92 -105
  12. data/lib/kameleon/context.rb +76 -43
  13. data/lib/kameleon/engine.rb +147 -103
  14. data/lib/kameleon/environment.rb +10 -5
  15. data/lib/kameleon/error.rb +1 -32
  16. data/lib/kameleon/persistent_cache.rb +127 -29
  17. data/lib/kameleon/recipe.rb +63 -106
  18. data/lib/kameleon/shell.rb +32 -17
  19. data/lib/kameleon/step.rb +18 -1
  20. data/lib/kameleon/ui.rb +141 -0
  21. data/lib/kameleon/utils.rb +9 -0
  22. data/templates/{debian7-chroot.yaml → chroot/debian7-amd64.yaml} +29 -21
  23. data/templates/{docker-debian7.yaml → docker/debian7.yaml} +5 -5
  24. data/templates/extend.erb +2 -2
  25. data/templates/{debian7-g5k.yaml → grid5000/debian7.yaml} +1 -1
  26. data/templates/{archlinux-desktop.yaml → qemu/archlinux-desktop-i686.yaml} +2 -2
  27. data/templates/qemu/archlinux-desktop-x86_64.yaml +25 -0
  28. data/templates/qemu/archlinux-i686.yaml +25 -0
  29. data/templates/{archlinux.yaml → qemu/archlinux-x86_64.yaml} +37 -34
  30. data/templates/qemu/centos6.5-x86_64.yaml +113 -0
  31. data/templates/qemu/centos7-x86_64.yaml +119 -0
  32. data/templates/{debian7.yaml → qemu/debian7-amd64.yaml} +45 -40
  33. data/templates/{debian7-desktop.yaml → qemu/debian7-desktop-amd64.yaml} +2 -3
  34. data/templates/{debian7-kameleon.yaml → qemu/debian7-kameleon-amd64.yaml} +3 -6
  35. data/templates/{debian7-oar-dev.yaml → qemu/debian7-oar-amd64.yaml} +2 -2
  36. data/templates/qemu/debian8-amd64.yaml +25 -0
  37. data/templates/{fedora20-desktop.yaml → qemu/fedora20-desktop-x86_64.yaml} +2 -2
  38. data/templates/qemu/fedora20-x86_64.yaml +116 -0
  39. data/templates/{ubuntu-12.04.yaml → qemu/ubuntu-12.04-amd64.yaml} +42 -38
  40. data/templates/{ubuntu-12.04-desktop.yaml → qemu/ubuntu-12.04-desktop-amd64.yaml} +3 -3
  41. data/templates/{ubuntu-14.04.yaml → qemu/ubuntu-14.04-amd64.yaml} +2 -2
  42. data/templates/{ubuntu-14.04-desktop.yaml → qemu/ubuntu-14.04-desktop-amd64.yaml} +2 -2
  43. data/templates/steps/aliases/defaults.yaml +19 -13
  44. data/templates/steps/bootstrap/archlinux/arch_bootstrap.yaml +11 -19
  45. data/templates/steps/bootstrap/debian/debootstrap.yaml +10 -11
  46. data/templates/steps/bootstrap/debian/debootstrap_arm.yaml +11 -19
  47. data/templates/steps/bootstrap/fedora/init_pxeboot.yaml +13 -0
  48. data/templates/steps/bootstrap/fedora/yum_bootstrap.yaml +45 -0
  49. data/templates/steps/bootstrap/initialize_disk.yaml +16 -0
  50. data/templates/steps/bootstrap/initialize_disk_chroot.yaml +10 -14
  51. data/templates/steps/bootstrap/install_requirements.yaml +3 -0
  52. data/templates/steps/bootstrap/prepare_docker.yaml +7 -7
  53. data/templates/steps/bootstrap/prepare_qemu.yaml +20 -26
  54. data/templates/steps/bootstrap/prepare_virtualbox.yaml +63 -0
  55. data/templates/steps/bootstrap/start_chroot.yaml +2 -13
  56. data/templates/steps/bootstrap/start_qemu.yaml +50 -53
  57. data/templates/steps/bootstrap/start_virtualbox.yaml +37 -0
  58. data/templates/steps/bootstrap/switch_context_qemu.yaml +64 -0
  59. data/templates/steps/bootstrap/switch_context_virtualbox.yaml +66 -0
  60. data/templates/steps/breakpoint.yaml +2 -1
  61. data/templates/steps/checkpoints/docker.yaml +14 -11
  62. data/templates/steps/checkpoints/qcow2.yaml +26 -24
  63. data/templates/steps/checkpoints/qemu.yaml +30 -36
  64. data/templates/steps/checkpoints/virtualbox.yaml +21 -0
  65. data/templates/steps/disable_checkpoint.yaml +3 -0
  66. data/templates/steps/enable_checkpoint.yaml +5 -0
  67. data/templates/steps/export/qemu_save_appliance.yaml +52 -0
  68. data/templates/steps/export/virtualbox_save_appliance.yaml +67 -0
  69. data/templates/steps/setup/archlinux/install_bootloader.yaml +23 -0
  70. data/templates/steps/setup/centos/6.5/configure_network.yaml +31 -0
  71. data/templates/steps/setup/centos/6.5/configure_system.yaml +27 -0
  72. data/templates/steps/setup/debian/configure_apt.yaml +1 -6
  73. data/templates/steps/setup/debian/configure_kernel.yaml +0 -5
  74. data/templates/steps/setup/debian/install_bootloader.yaml +36 -0
  75. data/templates/steps/setup/debian/setup_vagrant_box.yaml +48 -18
  76. data/templates/steps/setup/debian/upgrade_system.yaml +2 -7
  77. data/templates/steps/setup/fedora/configure_kernel.yaml +9 -0
  78. data/templates/steps/setup/fedora/configure_keyboard.yaml +12 -0
  79. data/templates/steps/setup/fedora/configure_network.yaml +9 -1
  80. data/templates/steps/setup/fedora/configure_system.yaml +20 -45
  81. data/templates/steps/setup/fedora/install_bootloader.yaml +58 -0
  82. data/templates/steps/setup/fedora/minimal_install.yaml +3 -0
  83. data/templates/steps/setup/fedora/update_system.yaml +13 -5
  84. data/templates/steps/setup/ubuntu/configure_apt.yaml +4 -9
  85. data/templates/vagrant/debian7-amd64.yaml +130 -0
  86. data/templates/virtualbox/archlinux-desktop-i686.yaml +25 -0
  87. data/templates/virtualbox/archlinux-desktop-x86_64.yaml +28 -0
  88. data/templates/virtualbox/archlinux-i686.yaml +28 -0
  89. data/templates/virtualbox/archlinux-x86_64.yaml +109 -0
  90. data/templates/virtualbox/centos6.5-i386.yaml +39 -0
  91. data/templates/virtualbox/centos6.5-x86_64.yaml +111 -0
  92. data/templates/virtualbox/centos7-x86_64.yaml +116 -0
  93. data/{docs/source/debian7.yaml → templates/virtualbox/debian7-amd64.yaml} +53 -52
  94. data/templates/virtualbox/debian7-desktop-amd64.yaml +25 -0
  95. data/templates/{fedora-rawhide.yaml → virtualbox/debian7-i386.yaml} +12 -11
  96. data/templates/virtualbox/debian7-kameleon-amd64.yaml +38 -0
  97. data/templates/virtualbox/debian7-oar-amd64.yaml +51 -0
  98. data/templates/{debian-testing.yaml → virtualbox/debian8-amd64.yaml} +3 -3
  99. data/templates/virtualbox/debian8-i386.yaml +31 -0
  100. data/templates/virtualbox/fedora20-x86_64.yaml +116 -0
  101. data/templates/virtualbox/ubuntu-12.04-amd64.yaml +128 -0
  102. data/templates/virtualbox/ubuntu-12.04-desktop-amd64.yaml +25 -0
  103. data/templates/virtualbox/ubuntu-14.04-amd64.yaml +25 -0
  104. data/templates/virtualbox/ubuntu-14.04-desktop-amd64.yaml +27 -0
  105. data/version.txt +1 -1
  106. metadata +67 -212
  107. data/Rakefile +0 -24
  108. data/docs/.gitignore +0 -1
  109. data/docs/Makefile +0 -181
  110. data/docs/README.md +0 -17
  111. data/docs/make.bat +0 -242
  112. data/docs/source/_static/.gitignore +0 -0
  113. data/docs/source/_static/centos.png +0 -0
  114. data/docs/source/_static/debian.png +0 -0
  115. data/docs/source/_static/kameleon-logo.png +0 -0
  116. data/docs/source/_static/kameleon-logo.xcf +0 -0
  117. data/docs/source/_static/kameleon-long.png +0 -0
  118. data/docs/source/_static/ubuntu.png +0 -0
  119. data/docs/source/_themes/sphinx_rtd_theme/__init__.py +0 -17
  120. data/docs/source/_themes/sphinx_rtd_theme/breadcrumbs.html +0 -19
  121. data/docs/source/_themes/sphinx_rtd_theme/footer.html +0 -32
  122. data/docs/source/_themes/sphinx_rtd_theme/layout.html +0 -160
  123. data/docs/source/_themes/sphinx_rtd_theme/layout_old.html +0 -205
  124. data/docs/source/_themes/sphinx_rtd_theme/search.html +0 -50
  125. data/docs/source/_themes/sphinx_rtd_theme/searchbox.html +0 -7
  126. data/docs/source/_themes/sphinx_rtd_theme/static/css/badge_only.css +0 -1
  127. data/docs/source/_themes/sphinx_rtd_theme/static/css/theme.css +0 -4
  128. data/docs/source/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf +0 -0
  129. data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot +0 -0
  130. data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg +0 -414
  131. data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf +0 -0
  132. data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff +0 -0
  133. data/docs/source/_themes/sphinx_rtd_theme/static/js/theme.js +0 -47
  134. data/docs/source/_themes/sphinx_rtd_theme/theme.conf +0 -8
  135. data/docs/source/_themes/sphinx_rtd_theme/versions.html +0 -37
  136. data/docs/source/aliases.rst +0 -31
  137. data/docs/source/atlas_debian_g5k.yaml +0 -36
  138. data/docs/source/checkpoint.rst +0 -30
  139. data/docs/source/commands.rst +0 -63
  140. data/docs/source/conf.py +0 -262
  141. data/docs/source/context.rst +0 -47
  142. data/docs/source/debian_customized.yaml +0 -28
  143. data/docs/source/debian_customized_g5k.yaml +0 -21
  144. data/docs/source/faq.rst +0 -43
  145. data/docs/source/getting_started.rst +0 -260
  146. data/docs/source/grid5000_tutorial.rst +0 -525
  147. data/docs/source/index.rst +0 -53
  148. data/docs/source/install_atlas.yaml +0 -25
  149. data/docs/source/install_hpl.yaml +0 -24
  150. data/docs/source/installation.rst +0 -51
  151. data/docs/source/persistent_cache.rst +0 -34
  152. data/docs/source/recipe.rst +0 -177
  153. data/docs/source/tau_install.yaml +0 -19
  154. data/docs/source/tau_install_g5k.yaml +0 -25
  155. data/docs/source/use_cases.rst +0 -93
  156. data/docs/source/workspace.rst +0 -13
  157. data/lib/kameleon/logger.rb +0 -56
  158. data/omnibus/.gitignore +0 -11
  159. data/omnibus/.kitchen.yml +0 -25
  160. data/omnibus/Berksfile +0 -9
  161. data/omnibus/Berksfile.lock +0 -25
  162. data/omnibus/Gemfile +0 -12
  163. data/omnibus/README.md +0 -94
  164. data/omnibus/config/projects/kameleon.rb +0 -23
  165. data/omnibus/config/software/kameleon.rb +0 -24
  166. data/omnibus/config/software/polipo.rb +0 -30
  167. data/omnibus/config/software/ruby.rb +0 -158
  168. data/omnibus/files/mac_dmg/Resources/background.png +0 -0
  169. data/omnibus/files/mac_dmg/Resources/icon.png +0 -0
  170. data/omnibus/files/mac_pkg/Resources/background.png +0 -0
  171. data/omnibus/files/mac_pkg/Resources/license.html +0 -1
  172. data/omnibus/files/mac_pkg/Resources/welcome.html +0 -9
  173. data/omnibus/omnibus.rb +0 -27
  174. data/omnibus/package-scripts/kameleon/makeselfinst +0 -27
  175. data/omnibus/package-scripts/kameleon/postrm +0 -9
  176. data/templates/fedora20.yaml +0 -105
  177. data/templates/steps/bootstrap/archlinux/install_bootloader.yaml +0 -46
  178. data/templates/steps/bootstrap/archlinux/populate_disk.yaml +0 -39
  179. data/templates/steps/bootstrap/fedora/liveos_bootstrap.yaml +0 -123
  180. data/templates/steps/bootstrap/initialize_disk_qemu.yaml +0 -72
  181. data/templates/steps/bootstrap/install_bootloader.yaml +0 -42
  182. data/templates/steps/bootstrap/ubuntu/debootstrap.yaml +0 -27
  183. data/templates/steps/export/save_appliance.yaml +0 -58
  184. data/templates/steps/export/save_vagrant_box.yaml +0 -29
  185. data/templates/vagrant-debian7.yaml +0 -31
@@ -1,47 +0,0 @@
1
- $( document ).ready(function() {
2
- // Shift nav in mobile when clicking the menu.
3
- $(document).on('click', "[data-toggle='wy-nav-top']", function() {
4
- $("[data-toggle='wy-nav-shift']").toggleClass("shift");
5
- $("[data-toggle='rst-versions']").toggleClass("shift");
6
- });
7
- // Close menu when you click a link.
8
- $(document).on('click', ".wy-menu-vertical .current ul li a", function() {
9
- $("[data-toggle='wy-nav-shift']").removeClass("shift");
10
- $("[data-toggle='rst-versions']").toggleClass("shift");
11
- });
12
- $(document).on('click', "[data-toggle='rst-current-version']", function() {
13
- $("[data-toggle='rst-versions']").toggleClass("shift-up");
14
- });
15
- // Make tables responsive
16
- $("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
17
- });
18
-
19
- window.SphinxRtdTheme = (function (jquery) {
20
- var stickyNav = (function () {
21
- var navBar,
22
- win,
23
- stickyNavCssClass = 'stickynav',
24
- applyStickNav = function () {
25
- if (navBar.height() <= win.height()) {
26
- navBar.addClass(stickyNavCssClass);
27
- } else {
28
- navBar.removeClass(stickyNavCssClass);
29
- }
30
- },
31
- enable = function () {
32
- applyStickNav();
33
- win.on('resize', applyStickNav);
34
- },
35
- init = function () {
36
- navBar = jquery('nav.wy-nav-side:first');
37
- win = jquery(window);
38
- };
39
- jquery(init);
40
- return {
41
- enable : enable
42
- };
43
- }());
44
- return {
45
- StickyNav : stickyNav
46
- };
47
- }($));
@@ -1,8 +0,0 @@
1
- [theme]
2
- inherit = basic
3
- stylesheet = css/theme.css
4
-
5
- [options]
6
- typekit_id = hiw1hhg
7
- analytics_id =
8
- sticky_navigation = False
@@ -1,37 +0,0 @@
1
- {% if READTHEDOCS %}
2
- {# Add rst-badge after rst-versions for small badge style. #}
3
- <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
4
- <span class="rst-current-version" data-toggle="rst-current-version">
5
- <span class="fa fa-book"> Read the Docs</span>
6
- v: {{ current_version }}
7
- <span class="fa fa-caret-down"></span>
8
- </span>
9
- <div class="rst-other-versions">
10
- <dl>
11
- <dt>Versions</dt>
12
- {% for slug, url in versions %}
13
- <dd><a href="{{ url }}">{{ slug }}</a></dd>
14
- {% endfor %}
15
- </dl>
16
- <dl>
17
- <dt>Downloads</dt>
18
- {% for type, url in downloads %}
19
- <dd><a href="{{ url }}">{{ type }}</a></dd>
20
- {% endfor %}
21
- </dl>
22
- <dl>
23
- <dt>On Read the Docs</dt>
24
- <dd>
25
- <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">Project Home</a>
26
- </dd>
27
- <dd>
28
- <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">Builds</a>
29
- </dd>
30
- </dl>
31
- <hr/>
32
- Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.
33
-
34
- </div>
35
- </div>
36
- {% endif %}
37
-
@@ -1,31 +0,0 @@
1
- .. _`aliases`:
2
-
3
- -------
4
- Aliases
5
- -------
6
-
7
- The aliases can be used anywhere instead of a Kameleon command. Some aliases
8
- are provided with the templates in the ``steps/aliases/defaults.yaml`` files
9
- within your workspace. You can add your own aliases in this file.
10
-
11
- An alias is define by its name as a key and a list of commands as a value. You
12
- can call an alias with any number of arguments given in a list.
13
-
14
- The alias access this arguments using the ``@arg_index`` notation. The
15
- argument index start at 1. So, ``@1`` is the first argument ``@2`` is the
16
- second ans so on.
17
-
18
- A good example is the alias define to copy from the out to the in context:
19
-
20
- .. code-block:: yaml
21
-
22
- # alias definition
23
- out2in:
24
- - exec_in: mkdir -p $(dirname @2)
25
- - pipe:
26
- - exec_out: cat @1
27
- - exec_in: cat > @2
28
- # alias call
29
- out2in:
30
- - ./my_file_out
31
- - ./copy_of_my_file_in
@@ -1,36 +0,0 @@
1
- #==============================================================================
2
- # vim: softtabstop=2 shiftwidth=2 expandtab fenc=utf-8 cc=81 tw=80
3
- #==============================================================================
4
- #
5
- # DESCRIPTION: <MY RECIPE DESCRIPTION>
6
- #
7
- #==============================================================================
8
-
9
- ---
10
- extend: debian7-g5k
11
-
12
- global:
13
- # You can see the base template `debian7.yaml` to know the
14
- # variables that you can override
15
- g5k_user: user # CHANGE ME
16
- g5k_site: grenoble # CHANGE ME
17
-
18
- bootstrap:
19
- - @base
20
-
21
- setup:
22
- - @base
23
- - install_software:
24
- - packages: >
25
- g++ make taktuk openssh-server openmpi-bin openmpi-common openmpi-dev
26
- build-essential gfortran fort77 gnome-applets
27
- - install_atlas:
28
- - repository: http://sourceforge.net/projects/math-atlas/files/Stable/
29
- - version: "3.10.1"
30
- - install_hpl:
31
- - repository: "http://www.netlib.org/benchmark/hpl/"
32
- - version: "2.1"
33
- - hpl_makefile: "/tmp/Make.Linux"
34
-
35
- export:
36
- - @base
@@ -1,30 +0,0 @@
1
- .. _`checkpoint`:
2
-
3
- ----------
4
- Checkpoint
5
- ----------
6
-
7
- Kameleon provide a modular Checkpoint mechanism. Indeed, Kameleon give you the
8
- possibility to implement your own checkpoint mechanism, using for example the
9
- snapshot feature of your underneath filesystem. To do so, you have to fill in a
10
- YAML file, located in the ``steps/checkpoints`` folder of your workspace, in which
11
- you have to define 4 commands:
12
-
13
- create
14
- The checkpoint first creation command
15
-
16
- apply
17
- The command applies a previous checkpoint state before starting build
18
-
19
- clear
20
- Remove all checkpoints
21
-
22
- list
23
- List the available checkpoints
24
-
25
- You can use the Kameleon current microstep id in your command with like this
26
- ``@microstep_id``.
27
-
28
- The checkpoint is selected in the recipe with a key/value couple where the
29
- value is the checkpoint yaml file name: ``checkpoint: my_checkpoint_file.yaml``
30
-
@@ -1,63 +0,0 @@
1
- .. _`commands`:
2
-
3
- --------
4
- Commands
5
- --------
6
-
7
- Each command is a {key => value} pair. The key is the Kameleon command name,
8
- and the value is the argument for this command.
9
-
10
- Exec
11
- ~~~~
12
-
13
- The exec command is a simple command execute, in the given context, the user
14
- command in argument. The context is specified by the name suffix local, out or
15
- in like this ``exec_[in/out/local]``.
16
-
17
- It is mostly used to execute bash script or other comand line application.
18
-
19
- For example this command save the message "Hello world:" in the hello.txt file
20
- within the workdir of the *in* context:
21
-
22
- .. code-block:: yaml
23
-
24
- - exec_in: echo "Hello world!" > hello.txt
25
-
26
- Pipe
27
- ~~~~
28
-
29
- The ``pipe`` command allow to transfert any content from one context to
30
- another. It takes exec command in arguments.
31
-
32
- The transfert is done by sending the STDOUT of the first command to the STDIN
33
- of the second.
34
-
35
- For example, this pipe command copy my_file located in the out context workdir
36
- to the new_file within the in context workdir:
37
-
38
- .. code-block:: yaml
39
-
40
- - pipe:
41
- - exec_out: cat my_file
42
- - exec_in: cat > new_file
43
-
44
- This command are usually not used directly but with :ref:`Aliases`.
45
-
46
- Hooks
47
- ~~~~~
48
-
49
- The hook commands are design to defer some initialization or clean actions. It
50
- takes a list of exec and pipe command in arguments. They are named like this
51
- ``on_[section]_init`` and ``on_[section]_clean``.
52
-
53
- The section inside the command define on which section this clean will be
54
- executed. If the section is not specified the hook will be executed at the init
55
- or the clean of the current step.
56
-
57
- For example, if you want to clean the ``/tmp`` folder at the end of the setup,
58
- you can add anywhere in a step:
59
-
60
- .. code-block:: yaml
61
-
62
- - on_setup_clean:
63
- - exec_in: rm -rf /tmp/mytemp
data/docs/source/conf.py DELETED
@@ -1,262 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # Kameleon documentation build configuration file, created by
4
- # sphinx-quickstart on Thu Feb 13 14:02:53 2014.
5
- #
6
- # This file is execfile()d with the current directory set to its
7
- # containing dir.
8
- #
9
- # Note that not all possible configuration values are present in this
10
- # autogenerated file.
11
- #
12
- # All configuration values have a default; values that are commented out
13
- # serve to show the default.
14
-
15
- import os
16
- import datetime
17
- # If extensions (or modules to document with autodoc) are in another directory,
18
- # add these directories to sys.path here. If the directory is relative to the
19
- # documentation root, use os.path.abspath to make it absolute, like shown here.
20
- #sys.path.insert(0, os.path.abspath('.'))
21
-
22
- # -- General configuration ------------------------------------------------
23
-
24
- # If your documentation needs a minimal Sphinx version, state it here.
25
- #needs_sphinx = '1.0'
26
-
27
- # Add any Sphinx extension module names here, as strings. They can be
28
- # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29
- # ones.
30
- extensions = ['sphinx.ext.todo']
31
- AUTHORS = "Michael Mercier, Salem Harrache"
32
- # Add any paths that contain templates here, relative to this directory.
33
- templates_path = ['_templates']
34
-
35
- # The suffix of source filenames.
36
- source_suffix = '.rst'
37
-
38
- # The encoding of source files.
39
- #source_encoding = 'utf-8-sig'
40
-
41
- # The master toctree document.
42
- master_doc = 'index'
43
-
44
- # General information about the project.
45
- project = u'Kameleon'
46
- copyright = u'%s, Inria.fr' % datetime.datetime.now().year
47
-
48
- # The version info for the project you're documenting, acts as replacement for
49
- # |version| and |release|, also used in various other places throughout the
50
- # built documents.
51
- #
52
- # The short X.Y version.
53
- with open(os.path.join(os.path.dirname(__file__), '..', '..',
54
- 'version.txt')) as init_py:
55
- release = init_py.read().strip()
56
- # The short X.Y version.
57
- version = release.rstrip('.dev')
58
-
59
- # The language for content autogenerated by Sphinx. Refer to documentation
60
- # for a list of supported languages.
61
- #language = None
62
-
63
- # There are two options for replacing |today|: either, you set today to some
64
- # non-false value, then it is used:
65
- #today = ''
66
- # Else, today_fmt is used as the format for a strftime call.
67
- #today_fmt = '%B %d, %Y'
68
-
69
- # List of patterns, relative to source directory, that match files and
70
- # directories to ignore when looking for source files.
71
- exclude_patterns = ['_build']
72
-
73
- # The reST default role (used for this markup: `text`) to use for all
74
- # documents.
75
- #default_role = None
76
-
77
- # If true, '()' will be appended to :func: etc. cross-reference text.
78
- #add_function_parentheses = True
79
-
80
- # If true, the current module name will be prepended to all description
81
- # unit titles (such as .. function::).
82
- #add_module_names = True
83
-
84
- # If true, sectionauthor and moduleauthor directives will be shown in the
85
- # output. They are ignored by default.
86
- #show_authors = False
87
-
88
- # The name of the Pygments (syntax highlighting) style to use.
89
- # pygments_style = 'sphinx'
90
-
91
- # A list of ignored prefixes for module index sorting.
92
- #modindex_common_prefix = []
93
-
94
- # If true, keep warnings as "system message" paragraphs in the built documents.
95
- #keep_warnings = False
96
-
97
-
98
- # -- Options for HTML output ----------------------------------------------
99
-
100
- # The theme to use for HTML and HTML Help pages. See the documentation for
101
- # a list of builtin themes.
102
- # on_rtd is whether we are on readthedocs.org
103
-
104
- html_theme = 'sphinx_rtd_theme'
105
- html_theme_path = ['_themes']
106
- # html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
107
-
108
- # Theme options are theme-specific and customize the look and feel of a theme
109
- # further. For a list of options available for each theme, see the
110
- # documentation.
111
- #html_theme_options = {}
112
-
113
- # Add any paths that contain custom themes here, relative to this directory.
114
- #html_theme_path = []
115
-
116
- # The name for this set of Sphinx documents. If None, it defaults to
117
- # "<project> v<release> documentation".
118
- #html_title = None
119
-
120
- # A shorter title for the navigation bar. Default is the same as html_title.
121
- #html_short_title = None
122
-
123
- # The name of an image file (relative to this directory) to place at the top
124
- # of the sidebar.
125
- # html_logo = '_static/kameleon-long.png'
126
-
127
- # The name of an image file (within the static path) to use as favicon of the
128
- # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129
- # pixels large.
130
- #html_favicon = None
131
-
132
- # Add any paths that contain custom static files (such as style sheets) here,
133
- # relative to this directory. They are copied after the builtin static files,
134
- # so a file named "default.css" will overwrite the builtin "default.css".
135
- html_static_path = ['_static']
136
-
137
- # Add any extra paths that contain custom files (such as robots.txt or
138
- # .htaccess) here, relative to this directory. These files are copied
139
- # directly to the root of the documentation.
140
- #html_extra_path = []
141
-
142
- # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143
- # using the given strftime format.
144
- #html_last_updated_fmt = '%b %d, %Y'
145
-
146
- # If true, SmartyPants will be used to convert quotes and dashes to
147
- # typographically correct entities.
148
- #html_use_smartypants = True
149
-
150
- # Custom sidebar templates, maps document names to template names.
151
- # html_sidebars = {'**': ['sidebarintro.html', 'localtoc.html']}
152
-
153
- # Additional templates that should be rendered to pages, maps page names to
154
- # template names.
155
- #html_additional_pages = {}
156
-
157
- # If false, no module index is generated.
158
- #html_domain_indices = True
159
-
160
- # If false, no index is generated.
161
- #html_use_index = True
162
-
163
- # If true, the index is split into individual pages for each letter.
164
- #html_split_index = False
165
-
166
- # If true, links to the reST sources are added to the pages.
167
- #html_show_sourcelink = True
168
-
169
- # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170
- #html_show_sphinx = True
171
-
172
- # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173
- #html_show_copyright = True
174
-
175
- # If true, an OpenSearch description file will be output, and all pages will
176
- # contain a <link> tag referring to it. The value of this option must be the
177
- # base URL from which the finished HTML is served.
178
- #html_use_opensearch = ''
179
-
180
- # This is the file name suffix for HTML files (e.g. ".xhtml").
181
- #html_file_suffix = None
182
-
183
- # Output file base name for HTML help builder.
184
- htmlhelp_basename = 'Kameleondoc'
185
-
186
-
187
- # -- Options for LaTeX output ---------------------------------------------
188
-
189
- latex_logo = '_static/kameleon-long.png'
190
-
191
- latex_elements = {
192
- 'tableofcontents': "\\tableofcontents",
193
- 'preamble': '''%
194
- \pagestyle{plain}
195
- \pagenumbering{arabic}
196
- ''',
197
- }
198
-
199
- # Grouping the document tree into LaTeX files. List of tuples
200
- # (source start file, target name, title,
201
- # author, documentclass [howto, manual, or own class]).
202
- latex_documents = [
203
- ('index', 'Kameleon.tex', u'Kameleon Documentation',
204
- AUTHORS, 'howto'),
205
- ]
206
-
207
- # The name of an image file (relative to this directory) to place at the top of
208
- # the title page.
209
- #latex_logo = None
210
-
211
- # For "manual" documents, if this is true, then toplevel headings are parts,
212
- # not chapters.
213
- #latex_use_parts = False
214
-
215
- # If true, show page references after internal links.
216
- #latex_show_pagerefs = False
217
-
218
- # If true, show URL addresses after external links.
219
- #latex_show_urls = False
220
-
221
- # Documents to append as an appendix to all manuals.
222
- #latex_appendices = []
223
-
224
- # If false, no module index is generated.
225
- #latex_domain_indices = True
226
-
227
-
228
- # -- Options for manual page output ---------------------------------------
229
-
230
- # One entry per manual page. List of tuples
231
- # (source start file, name, description, authors, manual section).
232
- man_pages = [
233
- ('index', 'kameleon', u'Kameleon Documentation',
234
- AUTHORS.split(', '), 1)
235
- ]
236
-
237
- # If true, show URL addresses after external links.
238
- #man_show_urls = False
239
-
240
-
241
- # -- Options for Texinfo output -------------------------------------------
242
-
243
- # Grouping the document tree into Texinfo files. List of tuples
244
- # (source start file, target name, title, author,
245
- # dir menu entry, description, category)
246
- texinfo_documents = [
247
- ('index', 'Kameleon', u'Kameleon Documentation',
248
- AUTHORS, 'Kameleon',
249
- 'One line description of project.', 'Miscellaneous'),
250
- ]
251
-
252
- # Documents to append as an appendix to all manuals.
253
- #texinfo_appendices = []
254
-
255
- # If false, no module index is generated.
256
- #texinfo_domain_indices = True
257
-
258
- # How to display URL addresses: 'footnote', 'no', or 'inline'.
259
- #texinfo_show_urls = 'footnote'
260
-
261
- # If true, do not generate a @detailmenu in the "Top" node's menu.
262
- #texinfo_no_detailmenu = False