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.
- data/.editorconfig +0 -0
- data/.env +2 -6
- data/CHANGELOG.rst +74 -1
- data/Gemfile +20 -2
- data/README.rst +35 -25
- data/Thorfile +29 -0
- data/contrib/kameleon_bashrc.sh +61 -0
- data/contrib/polipo_env.sh +3 -2
- data/kameleon-builder.gemspec +3 -10
- data/lib/kameleon.rb +10 -14
- data/lib/kameleon/cli.rb +92 -105
- data/lib/kameleon/context.rb +76 -43
- data/lib/kameleon/engine.rb +147 -103
- data/lib/kameleon/environment.rb +10 -5
- data/lib/kameleon/error.rb +1 -32
- data/lib/kameleon/persistent_cache.rb +127 -29
- data/lib/kameleon/recipe.rb +63 -106
- data/lib/kameleon/shell.rb +32 -17
- data/lib/kameleon/step.rb +18 -1
- data/lib/kameleon/ui.rb +141 -0
- data/lib/kameleon/utils.rb +9 -0
- data/templates/{debian7-chroot.yaml → chroot/debian7-amd64.yaml} +29 -21
- data/templates/{docker-debian7.yaml → docker/debian7.yaml} +5 -5
- data/templates/extend.erb +2 -2
- data/templates/{debian7-g5k.yaml → grid5000/debian7.yaml} +1 -1
- data/templates/{archlinux-desktop.yaml → qemu/archlinux-desktop-i686.yaml} +2 -2
- data/templates/qemu/archlinux-desktop-x86_64.yaml +25 -0
- data/templates/qemu/archlinux-i686.yaml +25 -0
- data/templates/{archlinux.yaml → qemu/archlinux-x86_64.yaml} +37 -34
- data/templates/qemu/centos6.5-x86_64.yaml +113 -0
- data/templates/qemu/centos7-x86_64.yaml +119 -0
- data/templates/{debian7.yaml → qemu/debian7-amd64.yaml} +45 -40
- data/templates/{debian7-desktop.yaml → qemu/debian7-desktop-amd64.yaml} +2 -3
- data/templates/{debian7-kameleon.yaml → qemu/debian7-kameleon-amd64.yaml} +3 -6
- data/templates/{debian7-oar-dev.yaml → qemu/debian7-oar-amd64.yaml} +2 -2
- data/templates/qemu/debian8-amd64.yaml +25 -0
- data/templates/{fedora20-desktop.yaml → qemu/fedora20-desktop-x86_64.yaml} +2 -2
- data/templates/qemu/fedora20-x86_64.yaml +116 -0
- data/templates/{ubuntu-12.04.yaml → qemu/ubuntu-12.04-amd64.yaml} +42 -38
- data/templates/{ubuntu-12.04-desktop.yaml → qemu/ubuntu-12.04-desktop-amd64.yaml} +3 -3
- data/templates/{ubuntu-14.04.yaml → qemu/ubuntu-14.04-amd64.yaml} +2 -2
- data/templates/{ubuntu-14.04-desktop.yaml → qemu/ubuntu-14.04-desktop-amd64.yaml} +2 -2
- data/templates/steps/aliases/defaults.yaml +19 -13
- data/templates/steps/bootstrap/archlinux/arch_bootstrap.yaml +11 -19
- data/templates/steps/bootstrap/debian/debootstrap.yaml +10 -11
- data/templates/steps/bootstrap/debian/debootstrap_arm.yaml +11 -19
- data/templates/steps/bootstrap/fedora/init_pxeboot.yaml +13 -0
- data/templates/steps/bootstrap/fedora/yum_bootstrap.yaml +45 -0
- data/templates/steps/bootstrap/initialize_disk.yaml +16 -0
- data/templates/steps/bootstrap/initialize_disk_chroot.yaml +10 -14
- data/templates/steps/bootstrap/install_requirements.yaml +3 -0
- data/templates/steps/bootstrap/prepare_docker.yaml +7 -7
- data/templates/steps/bootstrap/prepare_qemu.yaml +20 -26
- data/templates/steps/bootstrap/prepare_virtualbox.yaml +63 -0
- data/templates/steps/bootstrap/start_chroot.yaml +2 -13
- data/templates/steps/bootstrap/start_qemu.yaml +50 -53
- data/templates/steps/bootstrap/start_virtualbox.yaml +37 -0
- data/templates/steps/bootstrap/switch_context_qemu.yaml +64 -0
- data/templates/steps/bootstrap/switch_context_virtualbox.yaml +66 -0
- data/templates/steps/breakpoint.yaml +2 -1
- data/templates/steps/checkpoints/docker.yaml +14 -11
- data/templates/steps/checkpoints/qcow2.yaml +26 -24
- data/templates/steps/checkpoints/qemu.yaml +30 -36
- data/templates/steps/checkpoints/virtualbox.yaml +21 -0
- data/templates/steps/disable_checkpoint.yaml +3 -0
- data/templates/steps/enable_checkpoint.yaml +5 -0
- data/templates/steps/export/qemu_save_appliance.yaml +52 -0
- data/templates/steps/export/virtualbox_save_appliance.yaml +67 -0
- data/templates/steps/setup/archlinux/install_bootloader.yaml +23 -0
- data/templates/steps/setup/centos/6.5/configure_network.yaml +31 -0
- data/templates/steps/setup/centos/6.5/configure_system.yaml +27 -0
- data/templates/steps/setup/debian/configure_apt.yaml +1 -6
- data/templates/steps/setup/debian/configure_kernel.yaml +0 -5
- data/templates/steps/setup/debian/install_bootloader.yaml +36 -0
- data/templates/steps/setup/debian/setup_vagrant_box.yaml +48 -18
- data/templates/steps/setup/debian/upgrade_system.yaml +2 -7
- data/templates/steps/setup/fedora/configure_kernel.yaml +9 -0
- data/templates/steps/setup/fedora/configure_keyboard.yaml +12 -0
- data/templates/steps/setup/fedora/configure_network.yaml +9 -1
- data/templates/steps/setup/fedora/configure_system.yaml +20 -45
- data/templates/steps/setup/fedora/install_bootloader.yaml +58 -0
- data/templates/steps/setup/fedora/minimal_install.yaml +3 -0
- data/templates/steps/setup/fedora/update_system.yaml +13 -5
- data/templates/steps/setup/ubuntu/configure_apt.yaml +4 -9
- data/templates/vagrant/debian7-amd64.yaml +130 -0
- data/templates/virtualbox/archlinux-desktop-i686.yaml +25 -0
- data/templates/virtualbox/archlinux-desktop-x86_64.yaml +28 -0
- data/templates/virtualbox/archlinux-i686.yaml +28 -0
- data/templates/virtualbox/archlinux-x86_64.yaml +109 -0
- data/templates/virtualbox/centos6.5-i386.yaml +39 -0
- data/templates/virtualbox/centos6.5-x86_64.yaml +111 -0
- data/templates/virtualbox/centos7-x86_64.yaml +116 -0
- data/{docs/source/debian7.yaml → templates/virtualbox/debian7-amd64.yaml} +53 -52
- data/templates/virtualbox/debian7-desktop-amd64.yaml +25 -0
- data/templates/{fedora-rawhide.yaml → virtualbox/debian7-i386.yaml} +12 -11
- data/templates/virtualbox/debian7-kameleon-amd64.yaml +38 -0
- data/templates/virtualbox/debian7-oar-amd64.yaml +51 -0
- data/templates/{debian-testing.yaml → virtualbox/debian8-amd64.yaml} +3 -3
- data/templates/virtualbox/debian8-i386.yaml +31 -0
- data/templates/virtualbox/fedora20-x86_64.yaml +116 -0
- data/templates/virtualbox/ubuntu-12.04-amd64.yaml +128 -0
- data/templates/virtualbox/ubuntu-12.04-desktop-amd64.yaml +25 -0
- data/templates/virtualbox/ubuntu-14.04-amd64.yaml +25 -0
- data/templates/virtualbox/ubuntu-14.04-desktop-amd64.yaml +27 -0
- data/version.txt +1 -1
- metadata +67 -212
- data/Rakefile +0 -24
- data/docs/.gitignore +0 -1
- data/docs/Makefile +0 -181
- data/docs/README.md +0 -17
- data/docs/make.bat +0 -242
- data/docs/source/_static/.gitignore +0 -0
- data/docs/source/_static/centos.png +0 -0
- data/docs/source/_static/debian.png +0 -0
- data/docs/source/_static/kameleon-logo.png +0 -0
- data/docs/source/_static/kameleon-logo.xcf +0 -0
- data/docs/source/_static/kameleon-long.png +0 -0
- data/docs/source/_static/ubuntu.png +0 -0
- data/docs/source/_themes/sphinx_rtd_theme/__init__.py +0 -17
- data/docs/source/_themes/sphinx_rtd_theme/breadcrumbs.html +0 -19
- data/docs/source/_themes/sphinx_rtd_theme/footer.html +0 -32
- data/docs/source/_themes/sphinx_rtd_theme/layout.html +0 -160
- data/docs/source/_themes/sphinx_rtd_theme/layout_old.html +0 -205
- data/docs/source/_themes/sphinx_rtd_theme/search.html +0 -50
- data/docs/source/_themes/sphinx_rtd_theme/searchbox.html +0 -7
- data/docs/source/_themes/sphinx_rtd_theme/static/css/badge_only.css +0 -1
- data/docs/source/_themes/sphinx_rtd_theme/static/css/theme.css +0 -4
- data/docs/source/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf +0 -0
- data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot +0 -0
- data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg +0 -414
- data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf +0 -0
- data/docs/source/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff +0 -0
- data/docs/source/_themes/sphinx_rtd_theme/static/js/theme.js +0 -47
- data/docs/source/_themes/sphinx_rtd_theme/theme.conf +0 -8
- data/docs/source/_themes/sphinx_rtd_theme/versions.html +0 -37
- data/docs/source/aliases.rst +0 -31
- data/docs/source/atlas_debian_g5k.yaml +0 -36
- data/docs/source/checkpoint.rst +0 -30
- data/docs/source/commands.rst +0 -63
- data/docs/source/conf.py +0 -262
- data/docs/source/context.rst +0 -47
- data/docs/source/debian_customized.yaml +0 -28
- data/docs/source/debian_customized_g5k.yaml +0 -21
- data/docs/source/faq.rst +0 -43
- data/docs/source/getting_started.rst +0 -260
- data/docs/source/grid5000_tutorial.rst +0 -525
- data/docs/source/index.rst +0 -53
- data/docs/source/install_atlas.yaml +0 -25
- data/docs/source/install_hpl.yaml +0 -24
- data/docs/source/installation.rst +0 -51
- data/docs/source/persistent_cache.rst +0 -34
- data/docs/source/recipe.rst +0 -177
- data/docs/source/tau_install.yaml +0 -19
- data/docs/source/tau_install_g5k.yaml +0 -25
- data/docs/source/use_cases.rst +0 -93
- data/docs/source/workspace.rst +0 -13
- data/lib/kameleon/logger.rb +0 -56
- data/omnibus/.gitignore +0 -11
- data/omnibus/.kitchen.yml +0 -25
- data/omnibus/Berksfile +0 -9
- data/omnibus/Berksfile.lock +0 -25
- data/omnibus/Gemfile +0 -12
- data/omnibus/README.md +0 -94
- data/omnibus/config/projects/kameleon.rb +0 -23
- data/omnibus/config/software/kameleon.rb +0 -24
- data/omnibus/config/software/polipo.rb +0 -30
- data/omnibus/config/software/ruby.rb +0 -158
- data/omnibus/files/mac_dmg/Resources/background.png +0 -0
- data/omnibus/files/mac_dmg/Resources/icon.png +0 -0
- data/omnibus/files/mac_pkg/Resources/background.png +0 -0
- data/omnibus/files/mac_pkg/Resources/license.html +0 -1
- data/omnibus/files/mac_pkg/Resources/welcome.html +0 -9
- data/omnibus/omnibus.rb +0 -27
- data/omnibus/package-scripts/kameleon/makeselfinst +0 -27
- data/omnibus/package-scripts/kameleon/postrm +0 -9
- data/templates/fedora20.yaml +0 -105
- data/templates/steps/bootstrap/archlinux/install_bootloader.yaml +0 -46
- data/templates/steps/bootstrap/archlinux/populate_disk.yaml +0 -39
- data/templates/steps/bootstrap/fedora/liveos_bootstrap.yaml +0 -123
- data/templates/steps/bootstrap/initialize_disk_qemu.yaml +0 -72
- data/templates/steps/bootstrap/install_bootloader.yaml +0 -42
- data/templates/steps/bootstrap/ubuntu/debootstrap.yaml +0 -27
- data/templates/steps/export/save_appliance.yaml +0 -58
- data/templates/steps/export/save_vagrant_box.yaml +0 -29
- data/templates/vagrant-debian7.yaml +0 -31
data/Rakefile
DELETED
@@ -1,24 +0,0 @@
|
|
1
|
-
require 'bundler/gem_tasks'
|
2
|
-
require 'rake/testtask'
|
3
|
-
|
4
|
-
begin
|
5
|
-
require 'coveralls/rake/task'
|
6
|
-
|
7
|
-
Coveralls::RakeTask.new
|
8
|
-
task :ci => ['set_coverage', 'test', 'coveralls:push']
|
9
|
-
rescue LoadError; end
|
10
|
-
|
11
|
-
|
12
|
-
task :set_coverage do
|
13
|
-
ENV['COVERAGE'] = 'true'
|
14
|
-
end
|
15
|
-
|
16
|
-
|
17
|
-
Rake::TestTask.new do |t|
|
18
|
-
t.libs << 'tests'
|
19
|
-
t.pattern = "tests/test_*.rb"
|
20
|
-
end
|
21
|
-
|
22
|
-
|
23
|
-
desc 'Default task which runs all tests with code coverage enabled'
|
24
|
-
task :default => ['set_coverage', 'test']
|
data/docs/.gitignore
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
build
|
data/docs/Makefile
DELETED
@@ -1,181 +0,0 @@
|
|
1
|
-
# Makefile for Sphinx documentation
|
2
|
-
#
|
3
|
-
|
4
|
-
# You can set these variables from the command line.
|
5
|
-
SPHINXOPTS =
|
6
|
-
SPHINXBUILD = sphinx-build
|
7
|
-
PAPER =
|
8
|
-
BUILDDIR = build
|
9
|
-
|
10
|
-
# User-friendly check for sphinx-build
|
11
|
-
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
12
|
-
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed : "easy_install sphinx sphinx_rtd_theme")
|
13
|
-
endif
|
14
|
-
|
15
|
-
# Internal variables.
|
16
|
-
PAPEROPT_a4 = -D latex_paper_size=a4
|
17
|
-
PAPEROPT_letter = -D latex_paper_size=letter
|
18
|
-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
19
|
-
# the i18n builder cannot share the environment and doctrees with the others
|
20
|
-
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
21
|
-
|
22
|
-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
23
|
-
|
24
|
-
help:
|
25
|
-
@echo "Please use \`make <target>' where <target> is one of"
|
26
|
-
@echo " html to make standalone HTML files"
|
27
|
-
@echo " dirhtml to make HTML files named index.html in directories"
|
28
|
-
@echo " singlehtml to make a single large HTML file"
|
29
|
-
@echo " pickle to make pickle files"
|
30
|
-
@echo " json to make JSON files"
|
31
|
-
@echo " htmlhelp to make HTML files and a HTML help project"
|
32
|
-
@echo " qthelp to make HTML files and a qthelp project"
|
33
|
-
@echo " devhelp to make HTML files and a Devhelp project"
|
34
|
-
@echo " epub to make an epub"
|
35
|
-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
36
|
-
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
37
|
-
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
38
|
-
@echo " text to make text files"
|
39
|
-
@echo " man to make manual pages"
|
40
|
-
@echo " texinfo to make Texinfo files"
|
41
|
-
@echo " info to make Texinfo files and run them through makeinfo"
|
42
|
-
@echo " gettext to make PO message catalogs"
|
43
|
-
@echo " changes to make an overview of all changed/added/deprecated items"
|
44
|
-
@echo " xml to make Docutils-native XML files"
|
45
|
-
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
46
|
-
@echo " linkcheck to check all external links for integrity"
|
47
|
-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
48
|
-
|
49
|
-
clean:
|
50
|
-
rm -rf $(BUILDDIR)/*
|
51
|
-
|
52
|
-
html:
|
53
|
-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
54
|
-
@echo
|
55
|
-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
56
|
-
|
57
|
-
dirhtml:
|
58
|
-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
59
|
-
@echo
|
60
|
-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
61
|
-
|
62
|
-
singlehtml:
|
63
|
-
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
64
|
-
@echo
|
65
|
-
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
66
|
-
|
67
|
-
publish: html
|
68
|
-
rsync -avh --exclude 'pkg' -e "ssh" $(BUILDDIR)/html/ kameleon.website:~/www
|
69
|
-
|
70
|
-
|
71
|
-
pickle:
|
72
|
-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
73
|
-
@echo
|
74
|
-
@echo "Build finished; now you can process the pickle files."
|
75
|
-
|
76
|
-
json:
|
77
|
-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
78
|
-
@echo
|
79
|
-
@echo "Build finished; now you can process the JSON files."
|
80
|
-
|
81
|
-
htmlhelp:
|
82
|
-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
83
|
-
@echo
|
84
|
-
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
85
|
-
".hhp project file in $(BUILDDIR)/htmlhelp."
|
86
|
-
|
87
|
-
qthelp:
|
88
|
-
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
89
|
-
@echo
|
90
|
-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
91
|
-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
92
|
-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Kameleon.qhcp"
|
93
|
-
@echo "To view the help file:"
|
94
|
-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Kameleon.qhc"
|
95
|
-
|
96
|
-
devhelp:
|
97
|
-
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
98
|
-
@echo
|
99
|
-
@echo "Build finished."
|
100
|
-
@echo "To view the help file:"
|
101
|
-
@echo "# mkdir -p $$HOME/.local/share/devhelp/Kameleon"
|
102
|
-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Kameleon"
|
103
|
-
@echo "# devhelp"
|
104
|
-
|
105
|
-
epub:
|
106
|
-
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
107
|
-
@echo
|
108
|
-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
109
|
-
|
110
|
-
latex:
|
111
|
-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
112
|
-
@echo
|
113
|
-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
114
|
-
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
115
|
-
"(use \`make latexpdf' here to do that automatically)."
|
116
|
-
|
117
|
-
latexpdf:
|
118
|
-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
119
|
-
@echo "Running LaTeX files through pdflatex..."
|
120
|
-
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
121
|
-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
122
|
-
|
123
|
-
latexpdfja:
|
124
|
-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
125
|
-
@echo "Running LaTeX files through platex and dvipdfmx..."
|
126
|
-
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
127
|
-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
128
|
-
|
129
|
-
text:
|
130
|
-
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
131
|
-
@echo
|
132
|
-
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
133
|
-
|
134
|
-
man:
|
135
|
-
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
136
|
-
@echo
|
137
|
-
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
138
|
-
|
139
|
-
texinfo:
|
140
|
-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
141
|
-
@echo
|
142
|
-
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
143
|
-
@echo "Run \`make' in that directory to run these through makeinfo" \
|
144
|
-
"(use \`make info' here to do that automatically)."
|
145
|
-
|
146
|
-
info:
|
147
|
-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
148
|
-
@echo "Running Texinfo files through makeinfo..."
|
149
|
-
make -C $(BUILDDIR)/texinfo info
|
150
|
-
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
151
|
-
|
152
|
-
gettext:
|
153
|
-
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
154
|
-
@echo
|
155
|
-
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
156
|
-
|
157
|
-
changes:
|
158
|
-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
159
|
-
@echo
|
160
|
-
@echo "The overview file is in $(BUILDDIR)/changes."
|
161
|
-
|
162
|
-
linkcheck:
|
163
|
-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
164
|
-
@echo
|
165
|
-
@echo "Link check complete; look for any errors in the above output " \
|
166
|
-
"or in $(BUILDDIR)/linkcheck/output.txt."
|
167
|
-
|
168
|
-
doctest:
|
169
|
-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
170
|
-
@echo "Testing of doctests in the sources finished, look at the " \
|
171
|
-
"results in $(BUILDDIR)/doctest/output.txt."
|
172
|
-
|
173
|
-
xml:
|
174
|
-
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
175
|
-
@echo
|
176
|
-
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
177
|
-
|
178
|
-
pseudoxml:
|
179
|
-
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
180
|
-
@echo
|
181
|
-
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
data/docs/README.md
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
Kameleon documentation
|
2
|
-
======================
|
3
|
-
|
4
|
-
The Kameleon documentation is written in ReStructured Text (.rst) format.
|
5
|
-
You can generate a documentaion from the rst source file to (almost) any
|
6
|
-
format with Sphinx. To do so, just
|
7
|
-
[install Sphinx](http://sphinx-doc.org/latest/install.html) and run for example:
|
8
|
-
```
|
9
|
-
make html
|
10
|
-
```
|
11
|
-
Now you can visualise the created documentation like this:
|
12
|
-
```
|
13
|
-
firefox ./build/html/index.html
|
14
|
-
```
|
15
|
-
|
16
|
-
An online version of this documentation can be found at this adresse:
|
17
|
-
<http://kameleon.readthedocs.org>
|
data/docs/make.bat
DELETED
@@ -1,242 +0,0 @@
|
|
1
|
-
@ECHO OFF
|
2
|
-
|
3
|
-
REM Command file for Sphinx documentation
|
4
|
-
|
5
|
-
if "%SPHINXBUILD%" == "" (
|
6
|
-
set SPHINXBUILD=sphinx-build
|
7
|
-
)
|
8
|
-
set BUILDDIR=build
|
9
|
-
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
|
10
|
-
set I18NSPHINXOPTS=%SPHINXOPTS% source
|
11
|
-
if NOT "%PAPER%" == "" (
|
12
|
-
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
13
|
-
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
14
|
-
)
|
15
|
-
|
16
|
-
if "%1" == "" goto help
|
17
|
-
|
18
|
-
if "%1" == "help" (
|
19
|
-
:help
|
20
|
-
echo.Please use `make ^<target^>` where ^<target^> is one of
|
21
|
-
echo. html to make standalone HTML files
|
22
|
-
echo. dirhtml to make HTML files named index.html in directories
|
23
|
-
echo. singlehtml to make a single large HTML file
|
24
|
-
echo. pickle to make pickle files
|
25
|
-
echo. json to make JSON files
|
26
|
-
echo. htmlhelp to make HTML files and a HTML help project
|
27
|
-
echo. qthelp to make HTML files and a qthelp project
|
28
|
-
echo. devhelp to make HTML files and a Devhelp project
|
29
|
-
echo. epub to make an epub
|
30
|
-
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
31
|
-
echo. text to make text files
|
32
|
-
echo. man to make manual pages
|
33
|
-
echo. texinfo to make Texinfo files
|
34
|
-
echo. gettext to make PO message catalogs
|
35
|
-
echo. changes to make an overview over all changed/added/deprecated items
|
36
|
-
echo. xml to make Docutils-native XML files
|
37
|
-
echo. pseudoxml to make pseudoxml-XML files for display purposes
|
38
|
-
echo. linkcheck to check all external links for integrity
|
39
|
-
echo. doctest to run all doctests embedded in the documentation if enabled
|
40
|
-
goto end
|
41
|
-
)
|
42
|
-
|
43
|
-
if "%1" == "clean" (
|
44
|
-
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
45
|
-
del /q /s %BUILDDIR%\*
|
46
|
-
goto end
|
47
|
-
)
|
48
|
-
|
49
|
-
|
50
|
-
%SPHINXBUILD% 2> nul
|
51
|
-
if errorlevel 9009 (
|
52
|
-
echo.
|
53
|
-
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
54
|
-
echo.installed, then set the SPHINXBUILD environment variable to point
|
55
|
-
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
56
|
-
echo.may add the Sphinx directory to PATH.
|
57
|
-
echo.
|
58
|
-
echo.If you don't have Sphinx installed, grab it from
|
59
|
-
echo.http://sphinx-doc.org/
|
60
|
-
exit /b 1
|
61
|
-
)
|
62
|
-
|
63
|
-
if "%1" == "html" (
|
64
|
-
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
65
|
-
if errorlevel 1 exit /b 1
|
66
|
-
echo.
|
67
|
-
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
68
|
-
goto end
|
69
|
-
)
|
70
|
-
|
71
|
-
if "%1" == "dirhtml" (
|
72
|
-
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
73
|
-
if errorlevel 1 exit /b 1
|
74
|
-
echo.
|
75
|
-
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
76
|
-
goto end
|
77
|
-
)
|
78
|
-
|
79
|
-
if "%1" == "singlehtml" (
|
80
|
-
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
81
|
-
if errorlevel 1 exit /b 1
|
82
|
-
echo.
|
83
|
-
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
84
|
-
goto end
|
85
|
-
)
|
86
|
-
|
87
|
-
if "%1" == "pickle" (
|
88
|
-
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
89
|
-
if errorlevel 1 exit /b 1
|
90
|
-
echo.
|
91
|
-
echo.Build finished; now you can process the pickle files.
|
92
|
-
goto end
|
93
|
-
)
|
94
|
-
|
95
|
-
if "%1" == "json" (
|
96
|
-
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
97
|
-
if errorlevel 1 exit /b 1
|
98
|
-
echo.
|
99
|
-
echo.Build finished; now you can process the JSON files.
|
100
|
-
goto end
|
101
|
-
)
|
102
|
-
|
103
|
-
if "%1" == "htmlhelp" (
|
104
|
-
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
105
|
-
if errorlevel 1 exit /b 1
|
106
|
-
echo.
|
107
|
-
echo.Build finished; now you can run HTML Help Workshop with the ^
|
108
|
-
.hhp project file in %BUILDDIR%/htmlhelp.
|
109
|
-
goto end
|
110
|
-
)
|
111
|
-
|
112
|
-
if "%1" == "qthelp" (
|
113
|
-
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
114
|
-
if errorlevel 1 exit /b 1
|
115
|
-
echo.
|
116
|
-
echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
117
|
-
.qhcp project file in %BUILDDIR%/qthelp, like this:
|
118
|
-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Kameleon.qhcp
|
119
|
-
echo.To view the help file:
|
120
|
-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Kameleon.ghc
|
121
|
-
goto end
|
122
|
-
)
|
123
|
-
|
124
|
-
if "%1" == "devhelp" (
|
125
|
-
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
126
|
-
if errorlevel 1 exit /b 1
|
127
|
-
echo.
|
128
|
-
echo.Build finished.
|
129
|
-
goto end
|
130
|
-
)
|
131
|
-
|
132
|
-
if "%1" == "epub" (
|
133
|
-
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
134
|
-
if errorlevel 1 exit /b 1
|
135
|
-
echo.
|
136
|
-
echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
137
|
-
goto end
|
138
|
-
)
|
139
|
-
|
140
|
-
if "%1" == "latex" (
|
141
|
-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
142
|
-
if errorlevel 1 exit /b 1
|
143
|
-
echo.
|
144
|
-
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
145
|
-
goto end
|
146
|
-
)
|
147
|
-
|
148
|
-
if "%1" == "latexpdf" (
|
149
|
-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
150
|
-
cd %BUILDDIR%/latex
|
151
|
-
make all-pdf
|
152
|
-
cd %BUILDDIR%/..
|
153
|
-
echo.
|
154
|
-
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
155
|
-
goto end
|
156
|
-
)
|
157
|
-
|
158
|
-
if "%1" == "latexpdfja" (
|
159
|
-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
160
|
-
cd %BUILDDIR%/latex
|
161
|
-
make all-pdf-ja
|
162
|
-
cd %BUILDDIR%/..
|
163
|
-
echo.
|
164
|
-
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
165
|
-
goto end
|
166
|
-
)
|
167
|
-
|
168
|
-
if "%1" == "text" (
|
169
|
-
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
170
|
-
if errorlevel 1 exit /b 1
|
171
|
-
echo.
|
172
|
-
echo.Build finished. The text files are in %BUILDDIR%/text.
|
173
|
-
goto end
|
174
|
-
)
|
175
|
-
|
176
|
-
if "%1" == "man" (
|
177
|
-
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
178
|
-
if errorlevel 1 exit /b 1
|
179
|
-
echo.
|
180
|
-
echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
181
|
-
goto end
|
182
|
-
)
|
183
|
-
|
184
|
-
if "%1" == "texinfo" (
|
185
|
-
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
186
|
-
if errorlevel 1 exit /b 1
|
187
|
-
echo.
|
188
|
-
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
189
|
-
goto end
|
190
|
-
)
|
191
|
-
|
192
|
-
if "%1" == "gettext" (
|
193
|
-
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
194
|
-
if errorlevel 1 exit /b 1
|
195
|
-
echo.
|
196
|
-
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
197
|
-
goto end
|
198
|
-
)
|
199
|
-
|
200
|
-
if "%1" == "changes" (
|
201
|
-
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
202
|
-
if errorlevel 1 exit /b 1
|
203
|
-
echo.
|
204
|
-
echo.The overview file is in %BUILDDIR%/changes.
|
205
|
-
goto end
|
206
|
-
)
|
207
|
-
|
208
|
-
if "%1" == "linkcheck" (
|
209
|
-
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
210
|
-
if errorlevel 1 exit /b 1
|
211
|
-
echo.
|
212
|
-
echo.Link check complete; look for any errors in the above output ^
|
213
|
-
or in %BUILDDIR%/linkcheck/output.txt.
|
214
|
-
goto end
|
215
|
-
)
|
216
|
-
|
217
|
-
if "%1" == "doctest" (
|
218
|
-
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
219
|
-
if errorlevel 1 exit /b 1
|
220
|
-
echo.
|
221
|
-
echo.Testing of doctests in the sources finished, look at the ^
|
222
|
-
results in %BUILDDIR%/doctest/output.txt.
|
223
|
-
goto end
|
224
|
-
)
|
225
|
-
|
226
|
-
if "%1" == "xml" (
|
227
|
-
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
228
|
-
if errorlevel 1 exit /b 1
|
229
|
-
echo.
|
230
|
-
echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
231
|
-
goto end
|
232
|
-
)
|
233
|
-
|
234
|
-
if "%1" == "pseudoxml" (
|
235
|
-
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
236
|
-
if errorlevel 1 exit /b 1
|
237
|
-
echo.
|
238
|
-
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
239
|
-
goto end
|
240
|
-
)
|
241
|
-
|
242
|
-
:end
|