+++ /dev/null
-# 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
-help:
- @echo "Please use \`make <target>' where <target> 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 " epub3 to make an epub3"
- @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)"
-
-.PHONY: clean
-clean:
- rm -rf $(BUILDDIR)/*
-
-.PHONY: html
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-.PHONY: dirhtml
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-.PHONY: singlehtml
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-.PHONY: pickle
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-.PHONY: json
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-.PHONY: htmlhelp
-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."
-
-.PHONY: qthelp
-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/OpenDaylightRelEngBuilder.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenDaylightRelEngBuilder.qhc"
-
-.PHONY: applehelp
-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."
-
-.PHONY: devhelp
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenDaylightRelEngBuilder"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenDaylightRelEngBuilder"
- @echo "# devhelp"
-
-.PHONY: epub
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-.PHONY: epub3
-epub3:
- $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
- @echo
- @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
-
-.PHONY: latex
-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)."
-
-.PHONY: latexpdf
-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."
-
-.PHONY: latexpdfja
-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."
-
-.PHONY: text
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-.PHONY: man
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-.PHONY: texinfo
-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)."
-
-.PHONY: info
-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."
-
-.PHONY: gettext
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-.PHONY: changes
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-.PHONY: linkcheck
-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."
-
-.PHONY: doctest
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
-
-.PHONY: coverage
-coverage:
- $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
- @echo "Testing of coverage in the sources finished, look at the " \
- "results in $(BUILDDIR)/coverage/python.txt."
-
-.PHONY: xml
-xml:
- $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
- @echo
- @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-.PHONY: pseudoxml
-pseudoxml:
- $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
- @echo
- @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+++ /dev/null
-@ECHO OFF\r
-\r
-REM Command file for Sphinx documentation\r
-\r
-if "%SPHINXBUILD%" == "" (\r
- set SPHINXBUILD=sphinx-build\r
-)\r
-set BUILDDIR=_build\r
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .\r
-set I18NSPHINXOPTS=%SPHINXOPTS% .\r
-if NOT "%PAPER%" == "" (\r
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\r
- set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\r
-)\r
-\r
-if "%1" == "" goto help\r
-\r
-if "%1" == "help" (\r
- :help\r
- echo.Please use `make ^<target^>` where ^<target^> is one of\r
- echo. html to make standalone HTML files\r
- echo. dirhtml to make HTML files named index.html in directories\r
- echo. singlehtml to make a single large HTML file\r
- echo. pickle to make pickle files\r
- echo. json to make JSON files\r
- echo. htmlhelp to make HTML files and a HTML help project\r
- echo. qthelp to make HTML files and a qthelp project\r
- echo. devhelp to make HTML files and a Devhelp project\r
- echo. epub to make an epub\r
- echo. epub3 to make an epub3\r
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\r
- echo. text to make text files\r
- echo. man to make manual pages\r
- echo. texinfo to make Texinfo files\r
- echo. gettext to make PO message catalogs\r
- echo. changes to make an overview over all changed/added/deprecated items\r
- echo. xml to make Docutils-native XML files\r
- echo. pseudoxml to make pseudoxml-XML files for display purposes\r
- echo. linkcheck to check all external links for integrity\r
- echo. doctest to run all doctests embedded in the documentation if enabled\r
- echo. coverage to run coverage check of the documentation if enabled\r
- goto end\r
-)\r
-\r
-if "%1" == "clean" (\r
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i\r
- del /q /s %BUILDDIR%\*\r
- goto end\r
-)\r
-\r
-\r
-REM Check if sphinx-build is available and fallback to Python version if any\r
-%SPHINXBUILD% 1>NUL 2>NUL\r
-if errorlevel 9009 goto sphinx_python\r
-goto sphinx_ok\r
-\r
-:sphinx_python\r
-\r
-set SPHINXBUILD=python -m sphinx.__init__\r
-%SPHINXBUILD% 2> nul\r
-if errorlevel 9009 (\r
- echo.\r
- echo.The 'sphinx-build' command was not found. Make sure you have Sphinx\r
- echo.installed, then set the SPHINXBUILD environment variable to point\r
- echo.to the full path of the 'sphinx-build' executable. Alternatively you\r
- echo.may add the Sphinx directory to PATH.\r
- echo.\r
- echo.If you don't have Sphinx installed, grab it from\r
- echo.http://sphinx-doc.org/\r
- exit /b 1\r
-)\r
-\r
-:sphinx_ok\r
-\r
-\r
-if "%1" == "html" (\r
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.\r
- goto end\r
-)\r
-\r
-if "%1" == "dirhtml" (\r
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\r
- goto end\r
-)\r
-\r
-if "%1" == "singlehtml" (\r
- %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.\r
- goto end\r
-)\r
-\r
-if "%1" == "pickle" (\r
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished; now you can process the pickle files.\r
- goto end\r
-)\r
-\r
-if "%1" == "json" (\r
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished; now you can process the JSON files.\r
- goto end\r
-)\r
-\r
-if "%1" == "htmlhelp" (\r
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished; now you can run HTML Help Workshop with the ^\r
-.hhp project file in %BUILDDIR%/htmlhelp.\r
- goto end\r
-)\r
-\r
-if "%1" == "qthelp" (\r
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished; now you can run "qcollectiongenerator" with the ^\r
-.qhcp project file in %BUILDDIR%/qthelp, like this:\r
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OpenDaylightRelEngBuilder.qhcp\r
- echo.To view the help file:\r
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OpenDaylightRelEngBuilder.ghc\r
- goto end\r
-)\r
-\r
-if "%1" == "devhelp" (\r
- %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished.\r
- goto end\r
-)\r
-\r
-if "%1" == "epub" (\r
- %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The epub file is in %BUILDDIR%/epub.\r
- goto end\r
-)\r
-\r
-if "%1" == "epub3" (\r
- %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.\r
- goto end\r
-)\r
-\r
-if "%1" == "latex" (\r
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\r
- goto end\r
-)\r
-\r
-if "%1" == "latexpdf" (\r
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
- cd %BUILDDIR%/latex\r
- make all-pdf\r
- cd %~dp0\r
- echo.\r
- echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
- goto end\r
-)\r
-\r
-if "%1" == "latexpdfja" (\r
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
- cd %BUILDDIR%/latex\r
- make all-pdf-ja\r
- cd %~dp0\r
- echo.\r
- echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
- goto end\r
-)\r
-\r
-if "%1" == "text" (\r
- %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The text files are in %BUILDDIR%/text.\r
- goto end\r
-)\r
-\r
-if "%1" == "man" (\r
- %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The manual pages are in %BUILDDIR%/man.\r
- goto end\r
-)\r
-\r
-if "%1" == "texinfo" (\r
- %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.\r
- goto end\r
-)\r
-\r
-if "%1" == "gettext" (\r
- %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The message catalogs are in %BUILDDIR%/locale.\r
- goto end\r
-)\r
-\r
-if "%1" == "changes" (\r
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.The overview file is in %BUILDDIR%/changes.\r
- goto end\r
-)\r
-\r
-if "%1" == "linkcheck" (\r
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Link check complete; look for any errors in the above output ^\r
-or in %BUILDDIR%/linkcheck/output.txt.\r
- goto end\r
-)\r
-\r
-if "%1" == "doctest" (\r
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Testing of doctests in the sources finished, look at the ^\r
-results in %BUILDDIR%/doctest/output.txt.\r
- goto end\r
-)\r
-\r
-if "%1" == "coverage" (\r
- %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Testing of coverage in the sources finished, look at the ^\r
-results in %BUILDDIR%/coverage/python.txt.\r
- goto end\r
-)\r
-\r
-if "%1" == "xml" (\r
- %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The XML files are in %BUILDDIR%/xml.\r
- goto end\r
-)\r
-\r
-if "%1" == "pseudoxml" (\r
- %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml\r
- if errorlevel 1 exit /b 1\r
- echo.\r
- echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.\r
- goto end\r
-)\r
-\r
-:end\r
Code Review / releng / builder.git / commitdiff