diff --git a/source/Makefile b/source/Makefile index 655286aa..bb8ae7a8 100644 --- a/source/Makefile +++ b/source/Makefile @@ -1,192 +1,192 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ClearLinuxDocumentation.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ClearLinuxDocumentation.qhc" - -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/ClearLinuxDocumentation" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ClearLinuxDocumentation" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ClearLinuxDocumentation.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ClearLinuxDocumentation.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/ClearLinuxDocumentation" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ClearLinuxDocumentation" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/source/_static/images/clear-containers-v1.png b/source/_static/images/advanced/clear-containers-v1.png similarity index 100% rename from source/_static/images/clear-containers-v1.png rename to source/_static/images/advanced/clear-containers-v1.png diff --git a/source/_static/images/clear-containers-v2.png b/source/_static/images/advanced/clear-containers-v2.png similarity index 100% rename from source/_static/images/clear-containers-v2.png rename to source/_static/images/advanced/clear-containers-v2.png diff --git a/source/_static/images/dax-v1.png b/source/_static/images/advanced/dax-v1.png similarity index 100% rename from source/_static/images/dax-v1.png rename to source/_static/images/advanced/dax-v1.png diff --git a/source/_static/images/dax-v2.png b/source/_static/images/advanced/dax-v2.png similarity index 100% rename from source/_static/images/dax-v2.png rename to source/_static/images/advanced/dax-v2.png diff --git a/source/_static/images/icis_installer_workflow.png b/source/_static/images/advanced/icis_installer_workflow.png similarity index 100% rename from source/_static/images/icis_installer_workflow.png rename to source/_static/images/advanced/icis_installer_workflow.png diff --git a/source/_static/images/icis_pxe_diagram.png b/source/_static/images/advanced/icis_pxe_diagram.png similarity index 100% rename from source/_static/images/icis_pxe_diagram.png rename to source/_static/images/advanced/icis_pxe_diagram.png diff --git a/source/_static/images/pktgen_lw3fd.png b/source/_static/images/advanced/pktgen_lw3fd.png similarity index 100% rename from source/_static/images/pktgen_lw3fd.png rename to source/_static/images/advanced/pktgen_lw3fd.png diff --git a/source/_static/images/pyshical_net.png b/source/_static/images/advanced/pyshical_net.png similarity index 100% rename from source/_static/images/pyshical_net.png rename to source/_static/images/advanced/pyshical_net.png diff --git a/source/_static/images/use_case.png b/source/_static/images/advanced/use_case.png similarity index 100% rename from source/_static/images/use_case.png rename to source/_static/images/advanced/use_case.png diff --git a/source/_static/images/bundles/bundles_overview.png b/source/_static/images/bundles/bundles_overview.png new file mode 100644 index 00000000..f9fc55d3 Binary files /dev/null and b/source/_static/images/bundles/bundles_overview.png differ diff --git a/source/_static/images/image-blob-ciao-networking.png b/source/_static/images/ciao/blob-ciao-networking.png similarity index 100% rename from source/_static/images/image-blob-ciao-networking.png rename to source/_static/images/ciao/blob-ciao-networking.png diff --git a/source/_static/images/clearcontainersV1.svg b/source/_static/images/clearcontainersV1.svg index 23d68ea4..cc040db9 100644 --- a/source/_static/images/clearcontainersV1.svg +++ b/source/_static/images/clearcontainersV1.svg @@ -1,125 +1,125 @@ - - - - - - - -GitLab - - - - - - - - - - - - - - -
-
- -
-
-
-
-
-
-
-You need to sign in before continuing. -
-
- -
-
- - -
-
- - -
-
-
-
-
- - - + + + + + + + +GitLab + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+
+You need to sign in before continuing. +
+
+ +
+
+ + +
+
+ + +
+
+
+
+
+ + + diff --git a/source/_static/images/clearcontainersV2.svg b/source/_static/images/clearcontainersV2.svg index 7658c0e4..4d6389c6 100644 --- a/source/_static/images/clearcontainersV2.svg +++ b/source/_static/images/clearcontainersV2.svg @@ -1,125 +1,125 @@ - - - - - - - -GitLab - - - - - - - - - - - - - - -
-
- -
-
-
-
-
-
-
-You need to sign in before continuing. -
-
- -
-
- - -
-
- - -
-
-
-
-
- - - + + + + + + + +GitLab + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+
+You need to sign in before continuing. +
+
+ +
+
+ + +
+
+ + +
+
+
+
+
+ + + diff --git a/source/_static/images/dax-V1.svg b/source/_static/images/dax-V1.svg index 9c0d54ad..61819bf2 100644 --- a/source/_static/images/dax-V1.svg +++ b/source/_static/images/dax-V1.svg @@ -1,125 +1,125 @@ - - - - - - - -GitLab - - - - - - - - - - - - - - -
-
- -
-
-
-
-
-
-
-You need to sign in before continuing. -
-
- -
-
- - -
-
- - -
-
-
-
-
- - - + + + + + + + +GitLab + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+
+You need to sign in before continuing. +
+
+ +
+
+ + +
+
+ + +
+
+
+
+
+ + + diff --git a/source/_static/images/dax-V2.svg b/source/_static/images/dax-V2.svg index 24d07802..0ce4278b 100644 --- a/source/_static/images/dax-V2.svg +++ b/source/_static/images/dax-V2.svg @@ -1,125 +1,125 @@ - - - - - - - -GitLab - - - - - - - - - - - - - - -
-
- -
-
-
-
-
-
-
-You need to sign in before continuing. -
-
- -
-
- - -
-
- - -
-
-
-
-
- - - + + + + + + + +GitLab + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+
+You need to sign in before continuing. +
+
+ +
+
+ + +
+
+ + +
+
+
+
+
+ + + diff --git a/source/_static/images/gs_confirmation_screen.png b/source/_static/images/gs/gs_confirmation_screen.png similarity index 100% rename from source/_static/images/gs_confirmation_screen.png rename to source/_static/images/gs/gs_confirmation_screen.png diff --git a/source/_static/images/image-blob-ciao-networking.svg b/source/_static/images/image-blob-ciao-networking.svg index a76c4ae2..ba8ad101 100644 --- a/source/_static/images/image-blob-ciao-networking.svg +++ b/source/_static/images/image-blob-ciao-networking.svg @@ -1,766 +1,766 @@ - - - - - - - - - - - - - - - - - - - - - - - image-blob-ciao-networking - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + image-blob-ciao-networking + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/source/_themes/clearlinux/__init__.py b/source/_themes/clearlinux/__init__.py index 53aae3ea..b157e2f1 100644 --- a/source/_themes/clearlinux/__init__.py +++ b/source/_themes/clearlinux/__init__.py @@ -1,20 +1,20 @@ -import os - -from alabaster import _version as version - - -def get_path(): - """ - Shortcut for users whose theme is next to their conf.py. - """ - # Theme directory is defined as our parent directory - return os.path.abspath(os.path.dirname(os.path.dirname(__file__))) - - -def update_context(app, pagename, templatename, context, doctree): - context['alabaster_version'] = version.__version__ - -def setup(app): - app.connect('html-page-context', update_context) - return {'version': version.__version__, - 'parallel_read_safe': True} +import os + +from alabaster import _version as version + + +def get_path(): + """ + Shortcut for users whose theme is next to their conf.py. + """ + # Theme directory is defined as our parent directory + return os.path.abspath(os.path.dirname(os.path.dirname(__file__))) + + +def update_context(app, pagename, templatename, context, doctree): + context['alabaster_version'] = version.__version__ + +def setup(app): + app.connect('html-page-context', update_context) + return {'version': version.__version__, + 'parallel_read_safe': True} diff --git a/source/_themes/clearlinux/_version.py b/source/_themes/clearlinux/_version.py index 94b2a7b1..40ce5fcd 100644 --- a/source/_themes/clearlinux/_version.py +++ b/source/_themes/clearlinux/_version.py @@ -1,2 +1,2 @@ -__version_info__ = (0, 7, 6) -__version__ = '.'.join(map(str, __version_info__)) +__version_info__ = (0, 7, 6) +__version__ = '.'.join(map(str, __version_info__)) diff --git a/source/_themes/clearlinux/about.html b/source/_themes/clearlinux/about.html index 04ad8c4b..471ebf3c 100644 --- a/source/_themes/clearlinux/about.html +++ b/source/_themes/clearlinux/about.html @@ -1,39 +1,39 @@ -{% if theme_logo %} -

{{ project }}

- {% endif %} - -

-{% else %} -

{{ project }}

-{% endif %} - -{% if theme_description %} -

{{ theme_description }}

-{% endif %} - -{% if theme_github_button|lower == 'true' %} -

- -

-{% endif %} - -{% if theme_travis_button|lower != 'false' %} -{% if theme_travis_button|lower == 'true' %} - {% set path = theme_github_user + '/' + theme_github_repo %} -{% else %} - {% set path = theme_travis_button %} -{% endif %} -

- - https://secure.travis-ci.org/{{ path }}.png?branch=master - -

-{% endif %} +{% if theme_logo %} +

{{ project }}

+ {% endif %} + +

+{% else %} +

{{ project }}

+{% endif %} + +{% if theme_description %} +

{{ theme_description }}

+{% endif %} + +{% if theme_github_button|lower == 'true' %} +

+ +

+{% endif %} + +{% if theme_travis_button|lower != 'false' %} +{% if theme_travis_button|lower == 'true' %} + {% set path = theme_github_user + '/' + theme_github_repo %} +{% else %} + {% set path = theme_travis_button %} +{% endif %} +

+ + https://secure.travis-ci.org/{{ path }}.png?branch=master + +

+{% endif %} diff --git a/source/_themes/clearlinux/breadcrumbs.html b/source/_themes/clearlinux/breadcrumbs.html old mode 100755 new mode 100644 index 58bb7738..cc7a8e46 --- a/source/_themes/clearlinux/breadcrumbs.html +++ b/source/_themes/clearlinux/breadcrumbs.html @@ -1,14 +1,14 @@ -{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} - -{% if page_source_suffix %} -{% set suffix = page_source_suffix %} -{% else %} -{% set suffix = source_suffix %} -{% endif %} - - +{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} + +{% if page_source_suffix %} +{% set suffix = page_source_suffix %} +{% else %} +{% set suffix = source_suffix %} +{% endif %} + + diff --git a/source/_themes/clearlinux/donate.html b/source/_themes/clearlinux/donate.html index 62f289e9..79bb187d 100644 --- a/source/_themes/clearlinux/donate.html +++ b/source/_themes/clearlinux/donate.html @@ -1,9 +1,9 @@ -{% if theme_gratipay_user or theme_gittip_user %} -

Donate

-

-Consider supporting the authors on Gratipay: - -

-{% endif %} +{% if theme_gratipay_user or theme_gittip_user %} +

Donate

+

+Consider supporting the authors on Gratipay: + +

+{% endif %} diff --git a/source/_themes/clearlinux/footer.html b/source/_themes/clearlinux/footer.html old mode 100755 new mode 100644 index 4511b9c0..469c7b0c --- a/source/_themes/clearlinux/footer.html +++ b/source/_themes/clearlinux/footer.html @@ -1,32 +1,32 @@ - + diff --git a/source/_themes/clearlinux/header.html b/source/_themes/clearlinux/header.html old mode 100755 new mode 100644 index c9e14f16..2ddf083e --- a/source/_themes/clearlinux/header.html +++ b/source/_themes/clearlinux/header.html @@ -1,43 +1,43 @@ -
-
- - -
+
+
+ + +
diff --git a/source/_themes/clearlinux/layout.html b/source/_themes/clearlinux/layout.html index 71b48799..1553d7ce 100644 --- a/source/_themes/clearlinux/layout.html +++ b/source/_themes/clearlinux/layout.html @@ -1,183 +1,183 @@ -{# TEMPLATE VAR SETTINGS #} -{% set script_files = script_files + ['_static/js/affix.js'] %} -{% set script_files = script_files + ['_static/js/project.js'] %} -{%- set url_root = pathto('', 1) %} -{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} - - - - - - - {{ metatags }} - - {% block htmltitle %} - {{ title|striptags|e }}{{ titlesuffix }} - {% endblock %} - - - - - - - - - - - - - - - - - - - - - {# CSS #} - - {# OPENSEARCH #} - {% if not embedded %} - {% if use_opensearch %} - - {% endif %} - - {% endif %} - - {# RTD hosts this file, so just load on non RTD builds #} - {% if not READTHEDOCS %} - - {% endif %} - - {% for cssfile in css_files %} - - {% endfor %} - - {% for cssfile in extra_css_files %} - - {% endfor %} - - - - - {%- block linktags %} - {%- if hasdoc('about') %} - - {%- endif %} - {%- if hasdoc('genindex') %} - - {%- endif %} - {%- if hasdoc('search') %} - - {%- endif %} - {%- if hasdoc('copyright') %} - - {%- endif %} - - {%- if parents %} - - {%- endif %} - {%- if next %} - - {%- endif %} - {%- if prev %} - - {%- endif %} - {%- endblock %} - {%- block extrahead %} - {% if theme_touch_icon %} - - {% endif %} - - {% endblock %} - - {# Keep modernizr in head - http://modernizr.com/docs/#installing #} - - - - - -
- {% include "header.html" %} - {# PAGE CONTENT #} -
- -
-
-
-
-
-
-
-
-
{% include "navigation.html" %}
-
{% include "searchbox.html" %}
-
-
{% block body %}{% endblock %}
-
-
-
-
-
-
-
-
- {% include "footer.html" %} -
- {% if not embedded %} - - - {%- for scriptfile in script_files %} - - {%- endfor %} - - {% endif %} - - {# RTD hosts this file, so just load on non RTD builds #} - {% if not READTHEDOCS %} - - {% endif %} - - {# STICKY NAVIGATION #} - {% if theme_sticky_navigation %} - - {% endif %} - - - {# this is used when loading the search index using $.ajax fails, - such as on Chrome for documents on localhost #} - - {# Adding the google analytics tracking code #} - - {# Disable base theme's top+bottom related navs; we have our own in sidebar #} - {%- block relbar1 %}{% endblock %} - {%- block relbar2 %}{% endblock %} - {%- block footer %} {% endblock %} - - - +{# TEMPLATE VAR SETTINGS #} +{% set script_files = script_files + ['_static/js/affix.js'] %} +{% set script_files = script_files + ['_static/js/project.js'] %} +{%- set url_root = pathto('', 1) %} +{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} + + + + + + + {{ metatags }} + + {% block htmltitle %} + {{ title|striptags|e }}{{ titlesuffix }} + {% endblock %} + + + + + + + + + + + + + + + + + + + + + {# CSS #} + + {# OPENSEARCH #} + {% if not embedded %} + {% if use_opensearch %} + + {% endif %} + + {% endif %} + + {# RTD hosts this file, so just load on non RTD builds #} + {% if not READTHEDOCS %} + + {% endif %} + + {% for cssfile in css_files %} + + {% endfor %} + + {% for cssfile in extra_css_files %} + + {% endfor %} + + + + + {%- block linktags %} + {%- if hasdoc('about') %} + + {%- endif %} + {%- if hasdoc('genindex') %} + + {%- endif %} + {%- if hasdoc('search') %} + + {%- endif %} + {%- if hasdoc('copyright') %} + + {%- endif %} + + {%- if parents %} + + {%- endif %} + {%- if next %} + + {%- endif %} + {%- if prev %} + + {%- endif %} + {%- endblock %} + {%- block extrahead %} + {% if theme_touch_icon %} + + {% endif %} + + {% endblock %} + + {# Keep modernizr in head - http://modernizr.com/docs/#installing #} + + + + + +
+ {% include "header.html" %} + {# PAGE CONTENT #} +
+ +
+
+
+
+
+
+
+
+
{% include "navigation.html" %}
+
{% include "searchbox.html" %}
+
+
{% block body %}{% endblock %}
+
+
+
+
+
+
+
+
+ {% include "footer.html" %} +
+ {% if not embedded %} + + + {%- for scriptfile in script_files %} + + {%- endfor %} + + {% endif %} + + {# RTD hosts this file, so just load on non RTD builds #} + {% if not READTHEDOCS %} + + {% endif %} + + {# STICKY NAVIGATION #} + {% if theme_sticky_navigation %} + + {% endif %} + + + {# this is used when loading the search index using $.ajax fails, + such as on Chrome for documents on localhost #} + + {# Adding the google analytics tracking code #} + + {# Disable base theme's top+bottom related navs; we have our own in sidebar #} + {%- block relbar1 %}{% endblock %} + {%- block relbar2 %}{% endblock %} + {%- block footer %} {% endblock %} + + + diff --git a/source/_themes/clearlinux/navigation.html b/source/_themes/clearlinux/navigation.html index b06d30fc..f30cc6f9 100644 --- a/source/_themes/clearlinux/navigation.html +++ b/source/_themes/clearlinux/navigation.html @@ -1,12 +1,12 @@ - -

Content Map

- {% set toctree = toctree(maxdepth=2, collapse=theme_collapse_navigation, includehidden=True) %} - {% set toctree = toctree|replace("