[ismrmrd] 12/16: Updating project documentation generation
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Wed Jan 14 20:02:31 UTC 2015
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to annotated tag v1.2.0
in repository ismrmrd.
commit a20a24f99be8f4320092379e695f7949eb31b048
Merge: 7432921 6a4a927
Author: Joseph Naegele <joseph.naegele at gmail.com>
Date: Thu Dec 18 14:48:20 2014 -0500
Updating project documentation generation
checks for `sphinx-build` before adding HTML docs
to `doc` target. API docs are unchanged.
CMakeLists.txt | 14 ++-
bindings/python/Makefile | 13 +-
bindings/python/cismrmrd.pxd | 15 ++-
bindings/python/ismrmrd.pyx | 112 ++++++++++++++++-
doc/CMakeLists.txt | 28 +++--
doc/make.sphinx.bat.in | 242 ++++++++++++++++++++++++++++++++++++
examples/c/main.c | 6 +-
include/ismrmrd/ismrmrd.h | 3 +
include/ismrmrd/xml.h | 6 +
libsrc/ismrmrd.c | 76 +++++------
libsrc/xml.cpp | 16 ++-
matlab/+ismrmrd/+xml/deserialize.m | 133 +++-----------------
matlab/+ismrmrd/+xml/serialize.m | 129 +++++++++++--------
schema/ismrmrd.xsd | 28 +++--
schema/ismrmrd_example_extended.xml | 128 +++++++++++++++++++
utilities/CMakeLists.txt | 11 +-
utilities/ismrmrd_test_xml.cpp | 55 ++++++++
17 files changed, 773 insertions(+), 242 deletions(-)
diff --cc doc/CMakeLists.txt
index a38c98d,1c884c8..f22cd4e
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@@ -1,24 -1,10 +1,38 @@@
find_package(Doxygen)
if(DOXYGEN_FOUND)
- configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
- add_custom_target(doc ${DOXYGEN_EXECUTABLE}
- ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
- COMMENT "Generating API documentation with Doxygen" VERBATIM)
- add_custom_target(apidoc DEPENDS doc)
+ set(API_DOC_DIR ${CMAKE_CURRENT_BINARY_DIR}/html/api)
+ set(DOXYFILE ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${DOXYFILE} @ONLY)
+
+ add_custom_target(apidoc
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${API_DOC_DIR}
+ COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE}
+ COMMENT "Generating API documentation using Doxygen" VERBATIM)
else(DOXYGEN_FOUND)
-- MESSAGE("Doxygen not found. Will not be able to build documentation")
++ MESSAGE(STATUS "Doxygen not found. Not able to build API documentation")
endif(DOXYGEN_FOUND)
+
- set(SPHINX_MAKEFILE ${CMAKE_CURRENT_BINARY_DIR}/Makefile.sphinx)
- configure_file(Makefile.sphinx.in ${SPHINX_MAKEFILE} @ONLY)
- add_custom_target(htmldoc
- COMMAND make -f ${SPHINX_MAKEFILE} html
- COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/html/.nojekyll
- COMMENT "Generating HTML docs using Sphinx" VERBATIM)
++find_program(SPHINXBUILD sphinx-build)
++if(SPHINXBUILD)
++ if(WIN32)
++ set(SPHINX_MAKEBAT ${CMAKE_CURRENT_BINARY_DIR}/make.sphinx.bat)
++ configure_file(make.sphinx.bat.in ${SPHINX_MAKEBAT} @ONLY)
++ add_custom_target(htmldoc
++ COMMAND ${SPHINX_MAKEBAT} html
++ COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/html/.nojekyll
++ COMMENT "Generating HTML docs using Sphinx" VERBATIM)
++ else(WIN32)
++ set(SPHINX_MAKEFILE ${CMAKE_CURRENT_BINARY_DIR}/Makefile.sphinx)
++ configure_file(Makefile.sphinx.in ${SPHINX_MAKEFILE} @ONLY)
++ add_custom_target(htmldoc
++ COMMAND make -f ${SPHINX_MAKEFILE} html
++ COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/html/.nojekyll
++ COMMENT "Generating HTML docs using Sphinx" VERBATIM)
++ endif(WIN32)
++else(SPHINXBUILD)
++ MESSAGE(STATUS "sphinx-build not found. Not able to build HTML project documentation")
++endif(SPHINXBUILD)
+
+add_custom_target(doc)
+add_dependencies(doc apidoc htmldoc)
diff --cc doc/make.sphinx.bat.in
index 0000000,0000000..30a33f1
new file mode 100644
--- /dev/null
+++ b/doc/make.sphinx.bat.in
@@@ -1,0 -1,0 +1,242 @@@
++ at ECHO OFF
++
++REM Command file for Sphinx documentation
++
++if "%SPHINXBUILD%" == "" (
++ set SPHINXBUILD=sphinx-build
++)
++set BUILDDIR=@CMAKE_CURRENT_BINARY_DIR@
++set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% @CMAKE_CURRENT_SOURCE_DIR@/source
++set I18NSPHINXOPTS=%SPHINXOPTS% @CMAKE_CURRENT_SOURCE_DIR@/source
++if NOT "%PAPER%" == "" (
++ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
++ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
++)
++
++if "%1" == "" goto help
++
++if "%1" == "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. 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. text to make text files
++ echo. man to make manual pages
++ echo. texinfo to make Texinfo files
++ echo. gettext to make PO message catalogs
++ echo. changes to make an overview over 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
++ goto end
++)
++
++if "%1" == "clean" (
++ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
++ del /q /s %BUILDDIR%\*
++ goto end
++)
++
++
++%SPHINXBUILD% 2> nul
++if errorlevel 9009 (
++ echo.
++ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
++ echo.installed, then set the SPHINXBUILD environment variable to point
++ echo.to the full path of the 'sphinx-build' executable. Alternatively you
++ echo.may add the Sphinx directory to PATH.
++ echo.
++ echo.If you don't have Sphinx installed, grab it from
++ echo.http://sphinx-doc.org/
++ exit /b 1
++)
++
++if "%1" == "html" (
++ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
++ goto end
++)
++
++if "%1" == "dirhtml" (
++ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
++ goto end
++)
++
++if "%1" == "singlehtml" (
++ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
++ goto end
++)
++
++if "%1" == "pickle" (
++ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished; now you can process the pickle files.
++ goto end
++)
++
++if "%1" == "json" (
++ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished; now you can process the JSON files.
++ goto end
++)
++
++if "%1" == "htmlhelp" (
++ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished; now you can run HTML Help Workshop with the ^
++.hhp project file in %BUILDDIR%/htmlhelp.
++ goto end
++)
++
++if "%1" == "qthelp" (
++ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished; now you can run "qcollectiongenerator" with the ^
++.qhcp project file in %BUILDDIR%/qthelp, like this:
++ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ISMRMRD.qhcp
++ echo.To view the help file:
++ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ISMRMRD.ghc
++ goto end
++)
++
++if "%1" == "devhelp" (
++ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished.
++ goto end
++)
++
++if "%1" == "epub" (
++ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The epub file is in %BUILDDIR%/epub.
++ goto end
++)
++
++if "%1" == "latex" (
++ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
++ goto end
++)
++
++if "%1" == "latexpdf" (
++ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
++ cd %BUILDDIR%/latex
++ make all-pdf
++ cd %BUILDDIR%/..
++ echo.
++ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
++ goto end
++)
++
++if "%1" == "latexpdfja" (
++ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
++ cd %BUILDDIR%/latex
++ make all-pdf-ja
++ cd %BUILDDIR%/..
++ echo.
++ echo.Build finished; the PDF files are in %BUILDDIR%/latex.
++ goto end
++)
++
++if "%1" == "text" (
++ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The text files are in %BUILDDIR%/text.
++ goto end
++)
++
++if "%1" == "man" (
++ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The manual pages are in %BUILDDIR%/man.
++ goto end
++)
++
++if "%1" == "texinfo" (
++ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
++ goto end
++)
++
++if "%1" == "gettext" (
++ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
++ goto end
++)
++
++if "%1" == "changes" (
++ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.The overview file is in %BUILDDIR%/changes.
++ goto end
++)
++
++if "%1" == "linkcheck" (
++ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Link check complete; look for any errors in the above output ^
++or in %BUILDDIR%/linkcheck/output.txt.
++ goto end
++)
++
++if "%1" == "doctest" (
++ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Testing of doctests in the sources finished, look at the ^
++results in %BUILDDIR%/doctest/output.txt.
++ goto end
++)
++
++if "%1" == "xml" (
++ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The XML files are in %BUILDDIR%/xml.
++ goto end
++)
++
++if "%1" == "pseudoxml" (
++ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
++ if errorlevel 1 exit /b 1
++ echo.
++ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
++ goto end
++)
++
++:end
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/ismrmrd.git
More information about the debian-science-commits
mailing list