Commit f917518c authored by Tomas Sobotik's avatar Tomas Sobotik
Browse files

Merging with MASTER. Test functions DONE.

parent c0b0619f

AUTHORS

+6 −0
Original line number Diff line number Diff line 
Oberhuber Tomas <tomas.oberhuber@fjfi.cvut.cz>

Zabka Vitezslav <zabkavit@fjfi.cvut.cz>

Vladimir Klement

Tomáš Sobotík

Ondřej Székely

Jiří Kafka

Libor Bakajsa

Jakub Klinkovský

Vacata Jan

Heller Martin

Novotny Matej

CMakeLists.txt

+203 −76
Original line number Diff line number Diff line 
###############################################################################

#                      Cmake project script for TNL

#                             -------------------

#    begin               : Dec 8, 2010

#    copyright           : (C) 2010 by Tomas Oberhuber et al.

#    email               : tomas.oberhuber@fjfi.cvut.cz

#

###############################################################################

#

# Authors:

# Tomas Oberhuber

# Vladimir Klement

# Jakub Klinkovsky



cmake_minimum_required( VERSION 2.8.10 )



project( tnl )
@@ -15,21 +29,26 @@ include( UseCodeCoverage ) 
if( CMAKE_BUILD_TYPE STREQUAL "Debug")

    set( PROJECT_BUILD_PATH ${PROJECT_SOURCE_DIR}/Debug/src )

    set( PROJECT_TESTS_PATH ${PROJECT_SOURCE_DIR}/Debug/tests )

    set( PROJECT_TOOLS_PATH ${PROJECT_SOURCE_DIR}/Debug/tools )

    set( LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/Debug/lib )

    set( EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/Debug/bin )

    set( debugExt -dbg )

    AddCompilerFlag( "-g" )

    set( CMAKE_CXX_FLAGS "${CXXFLAGS} -g ")

    #AddCompilerFlag( "-g" )

else()

    set( PROJECT_BUILD_PATH ${PROJECT_SOURCE_DIR}/Release/src )

    set( PROJECT_TESTS_PATH ${PROJECT_SOURCE_DIR}/Release/tests )

    set( PROJECT_TOOLS_PATH ${PROJECT_SOURCE_DIR}/Release/tools )

    set( LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/Release/lib)

    set( EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/Release/bin)

    OptimizeForArchitecture()

    AddCompilerFlag( "-O3 -DNDEBUG" )

    #OptimizeForArchitecture()

    AddCompilerFlag( "-O3 -march=native -DNDEBUG -g" )

endif()



if( WITH_TEMPLATE_EXPLICIT_INSTANTIATION STREQUAL "yes" )

   AddCompilerFlag( "-DTEMPLATE_EXPLICIT_INSTANTIATION " )

get_filename_component( CXX_COMPILER_NAME ${CMAKE_CXX_COMPILER} NAME )

if( CXX_COMPILER_NAME MATCHES "icpc" )

   message( "Intel compiler detected..."    )

   AddCompilerFlag( "-DHAVE_ICPC" )

endif()



#####
@@ -42,12 +61,60 @@ if( WITH_CUDA STREQUAL "yes" ) 
        set(CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE OFF)

        set(BUILD_SHARED_LIBS ON)

        set(CUDA_SEPARABLE_COMPILATION ON)

        set(CUSPARSE_LIBRARY /usr/local/cuda/lib64/libcusparse.so) # TODO: fix this              

        set(CUDA_NVCC_FLAGS ${CUDA_NVCC_FLAGS} ; -DHAVE_CUDA )

        AddCompilerFlag( "-DHAVE_NOT_CXX11 -U_GLIBCXX_ATOMIC_BUILTINS -U_GLIBCXX_USE_INT128 " )          

        set( CUDA_ADD_EXECUTABLE_OPTIONS -gencode arch=compute_20,code=sm_20 -gencode arch=compute_30,code=sm_30 -gencode arch=compute_35,code=sm_35 )

        set( CUDA_ADD_LIBRARY_OPTIONS -gencode arch=compute_20,code=sm_20 -gencode arch=compute_30,code=sm_30 -gencode arch=compute_35,code=sm_35 -shared )

        #AddCompilerFlag( "-DHAVE_NOT_CXX11" ) # -U_GLIBCXX_ATOMIC_BUILTINS -U_GLIBCXX_USE_INT128 " )

        set( ALL_CUDA_ARCHS -gencode arch=compute_20,code=sm_20

                            -gencode arch=compute_30,code=sm_30

                            -gencode arch=compute_32,code=sm_32 

                            -gencode arch=compute_35,code=sm_35 

                            -gencode arch=compute_37,code=sm_37 

                            -gencode arch=compute_50,code=sm_50 

                            -gencode arch=compute_52,code=sm_52 )

        if( WITH_CUDA_ARCH STREQUAL "all" )

           set( CUDA_ARCH ${ALL_CUDA_ARCHS} )   

        else()

            if( WITH_CUDA_ARCH STREQUAL "auto")

                ####

                # Select GPU architecture

                #

                set( CUDA_ARCH_EXECUTABLE ${EXECUTABLE_OUTPUT_PATH}/tnl-cuda-arch)

                set( CUDA_ARCH_SOURCE ${PROJECT_SOURCE_DIR}/tools/src/tnl-cuda-arch.cu)

                message( "Compiling tnl-cuda-arch ..." )

                file( MAKE_DIRECTORY ${EXECUTABLE_OUTPUT_PATH} )

                execute_process( COMMAND nvcc ${CUDA_ARCH_SOURCE} -o ${CUDA_ARCH_EXECUTABLE}

                                 RESULT_VARIABLE CUDA_ARCH_RESULT

                                 OUTPUT_VARIABLE CUDA_ARCH_OUTPUT

                                 ERROR_VARIABLE CUDA_ARCH_OUTPUT )

                execute_process( COMMAND ${CUDA_ARCH_EXECUTABLE}

                                 OUTPUT_VARIABLE CUDA_ARCH )

                if( NOT CUDA_ARCH_RESULT )

                    # strip linebreaks and convert to list delimited with ';'

                    string( REGEX REPLACE "[\n ]" ";" CUDA_ARCH ${CUDA_ARCH} )

                    # cache the result

                    set( CUDA_ARCH ${CUDA_ARCH} CACHE LIST "GPU architecture options" )

                else()

                    message( "Failed to detect GPU architecture:\n${CUDA_ARCH_OUTPUT}" )

                    message( "Using (almost) all GPU architectures as fallback." )

                    set( CUDA_ARCH ${ALL_CUDA_ARCHS} )

                endif()

                message( "GPU architecture options:  ${CUDA_ARCH}" )

            else()

                set( CUDA_ARCH -gencode arch=compute_${WITH_CUDA_ARCH},code=sm_${WITH_CUDA_ARCH} )

            endif()

        endif()

        set( CUDA_ADD_EXECUTABLE_OPTIONS ${CUDA_ARCH} )

        set( CUDA_ADD_LIBRARY_OPTIONS ${CUDA_ARCH} -shared )

        set( CUDA_LINKER_OPTIONS "-arch sm_20 -shared" )



        ####

        # Check for cuBLAS

        #

        if( WITH_CUBLAS STREQUAL "yes" ) 

            message( "Enabling CUBLAS." )

            set( HAVE_CUBLAS TRUE)

            set( HAVE_CUBLAS "#define HAVE_CUBLAS 1" )

        endif( WITH_CUBLAS STREQUAL "yes" )       



        ####

        # Check for CUSP

        #
@@ -55,10 +122,10 @@ if( WITH_CUDA STREQUAL "yes" ) 
                   DOC "CUSP headers." )

        if( ${CUSP_INCLUDE_DIR} STREQUAL "CUSP_INCLUDE_DIR-NOTFOUND" )

            message( "CUSP not found." )

            set( HAVE_CUSP "//#define HAVE_CUSP" )

            set( HAVE_CUSP "//#define HAVE_CUSP 1" )

        else()      

            message( "CUSP found. -- ${CUSP_INCLUDE_DIR}" )

            set( HAVE_CUSP "#define HAVE_CUSP" )

            set( HAVE_CUSP "#define HAVE_CUSP 1" )

            cuda_include_directories( ${CUSP_INCLUDE_DIR} )

        endif()
@@ -73,28 +140,31 @@ if( WITH_CUDA STREQUAL "yes" ) 
                      DOC "CUSPARSE headers." )

           if( ${CUSPARSE_INCLUDE_DIR} STREQUAL "CUSPARSE_INCLUDE_DIR-NOTFOUND" )

               message( "CUSPARSE not found." )

               set( HAVE_CUSPARSE "//#define HAVE_CUSPARSE" )

               set( HAVE_CUSPARSE "//#define HAVE_CUSPARSE 1" )

           else()      

               message( "CUSPARSE found. -- ${CUSPARSE_INCLUDE_DIR}" )

               set( HAVE_CUSPARSE "#define HAVE_CUSPARSE" )

               set( HAVE_CUSPARSE "#define HAVE_CUSPARSE 1" )

               cuda_include_directories( ${CUSPARSE_INCLUDE_DIR} )

               set( CUSPARSE_LIBRARY "${CUDA_cusparse_LIBRARY}" )

           endif()            

        endif( NOT WITH_CUSPARSE STREQUAL "no" )

   

    else( CUDA_FOUND )

      AddCompilerFlag( "-std=gnu++0x" )         

    #else( CUDA_FOUND )

    #  AddCompilerFlag( "-std=c++11" )         

    endif( CUDA_FOUND )

else( WITH_CUDA STREQUAL "yes" )

   AddCompilerFlag( "-std=gnu++0x -ftree-vectorizer-verbose=1" )       

#else( WITH_CUDA STREQUAL "yes" )

   #AddCompilerFlag( "-std=gnu++0x -ftree-vectorizer-verbose=1" )       

   #AddCompilerFlag( "-std=c++11" )       

endif( WITH_CUDA STREQUAL "yes" )

AddCompilerFlag( "-std=c++11" )       



####

# Check for OpenMP

#

find_package( OpenMP ) 

if( OPENMP_FOUND )

   AddCompilerFlag( "-DHAVE_OPENMP -fopenmp" )

# TODO: finish this

   message( "Compiler supports OpenMP." )

   #set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DHAVE_OPENMP -fopenmp")

endif()



####
@@ -106,6 +176,38 @@ endif() 
#    message( "MPI headers found -- ${MPI_CXX_INCLUDE_PATH}")

#endif()



find_package( DCMTK )

if( DCMTK_FOUND )

   set( HAVE_DCMTK_H "#define HAVE_DCMTK_H 1" )

   include_directories( ${DCMTK_INCLUDE_DIRS} )

   set( HAVE_DCMTK TRUE)

   set( DCMTK_LD_FLAGS "" )

   foreach( arg ${DCMTK_LIBRARIES} )

      set( DCMTK_LD_FLAGS "${DCMTK_LD_FLAGS} ${arg}" )

   endforeach( arg ${DCMTK_LIBRARIES} )

else()

   set( HAVE_DCMTK_H "//#define HAVE_DCMTK_H 1" )

endif()



find_package( PNG )

if( PNG_FOUND )      

   set( HAVE_PNG_H "#define HAVE_PNG_H 1" )

   include_directories( ${PNG_INCLUDE_DIRS} )

else()

   set( HAVE_PNG_H "//#define HAVE_PNG_H 1" )

   set( PNG_LIBRARIES "" )

endif()



find_package( JPEG )

if( JPEG_FOUND )      

   set( HAVE_JPEG_H "#define HAVE_JPEG_H 1" )

   include_directories( ${JPEG_INCLUDE_DIRS} )

else()

   set( HAVE_JPEG_H "//#define HAVE_JPEG_H 1" )

   set( JPEG_LIBRARIES "" )

endif()





####

# Check for some system header

#
@@ -115,10 +217,10 @@ find_path( SYS_TIME_INCLUDE_DIR sys/time.h 
           DOC "System timer headers." )

if( ${SYS_TIME_INCLUDE_DIR} STREQUAL "SYS_TIME_INCLUDE_DIR-NOTFOUND" )

    message(  "Missing header file sys/time.h" )

    set( HAVE_SYS_TIME_H "//#define HAVE_SYS_TIME_H" )

    set( HAVE_SYS_TIME_H "//#define HAVE_SYS_TIME_H 1" )

else()

    include_directories( ${SYS_TIME_INCLUDE_DIR}/tnl-${tnlVersion} )

    set( HAVE_SYS_TIME_H "#define HAVE_SYS_TIME_H" )

    set( HAVE_SYS_TIME_H "#define HAVE_SYS_TIME_H 1" )

endif()



find_path( SYS_RESOURCE_INCLUDE_DIR sys/resource.h
@@ -127,18 +229,16 @@ find_path( SYS_RESOURCE_INCLUDE_DIR sys/resource.h 
           DOC "System resources headers." )

if( ${SYS_RESOURCE_INCLUDE_DIR} STREQUAL "SYS_RESOURCE_INCLUDE_DIR-NOTFOUND" )

    message( "Missing header file sys/time.h" )

    set( HAVE_SYS_RESOURCE_H "//#define HAVE_SYS_RESOURCE_H" )

    set( HAVE_SYS_RESOURCE_H "//#define HAVE_SYS_RESOURCE_H 1" )

else()

    include_directories( ${SYS_RESOURCE_INCLUDE_DIR}/tnl-${tnlVersion} )

    set( HAVE_SYS_RESOURCE_H "#define HAVE_SYS_RESOURCE_H" )

    set( HAVE_SYS_RESOURCE_H "#define HAVE_SYS_RESOURCE_H 1" )

endif()



  





####

# Check for cppunit

#

if( WITH_TESTS STREQUAL "yes" )

    FIND_PATH(CPPUNIT_INCLUDE_DIR cppunit/TestCase.h

      /usr/local/include

      /usr/include
@@ -172,7 +272,7 @@ endif(WIN32) 


    if( ${CPPUNIT_INCLUDE_DIR} STREQUAL "CPPUNIT_INCLUDE_DIR-NOTFOUND" )

          message( "CPPUNIT not found." )

      set( HAVE_CPPUNIT "//#define HAVE_CPPUNIT" )

          set( HAVE_CPPUNIT "//#define HAVE_CPPUNIT 1" )

    else( ${CPPUNIT_INCLUDE_DIR} STREQUAL "CPPUNIT_INCLUDE_DIR-NOTFOUND" )

      message( "CPPUNIT headers found -- ${CPPUNIT_INCLUDE_DIR}" )

      if(CPPUNIT_LIBRARY)
@@ -181,9 +281,12 @@ else( ${CPPUNIT_INCLUDE_DIR} STREQUAL "CPPUNIT_INCLUDE_DIR-NOTFOUND" ) 
        set(CPPUNIT_LIBRARIES ${CPPUNIT_LIBRARY} ${CMAKE_DL_LIBS})

        set(CPPUNIT_DEBUG_LIBRARIES ${CPPUNIT_DEBUG_LIBRARY}

                                    ${CMAKE_DL_LIBS})

   set( HAVE_CPPUNIT "#define HAVE_CPPUNIT" )

       set( HAVE_CPPUNIT "#define HAVE_CPPUNIT 1" )

      endif(CPPUNIT_LIBRARY)

    endif( ${CPPUNIT_INCLUDE_DIR} STREQUAL "CPPUNIT_INCLUDE_DIR-NOTFOUND" )

    ENABLE_TESTING()

    INCLUDE( Dart )

endif( WITH_TESTS STREQUAL "yes" )



#if( BUILD_MPI )

#   FIND_PATH( PETSC_INCLUDE_DIR petsc.h
@@ -210,9 +313,33 @@ endif( ${CPPUNIT_INCLUDE_DIR} STREQUAL "CPPUNIT_INCLUDE_DIR-NOTFOUND" ) 
#   endif()

#endif()



####

# Explicit template instantiation

#

if( WITH_TEMPLATE_INSTANTIATION STREQUAL "yes" )

   AddCompilerFlag( "-DTEMPLATE_EXPLICIT_INSTANTIATION " )

endif()   



if( INSTANTIATE_INT STREQUAL "yes" )

   AddCompilerFlag( "-DINSTANTIATE_INT " )

endif()   



if( INSTANTIATE_LONG_INT STREQUAL "yes" )

   AddCompilerFlag( "-DINSTANTIATE_LONG_INT " )

endif()   



if( INSTANTIATE_FLOAT STREQUAL "yes" )

   AddCompilerFlag( "-DINSTANTIATE_FLOAT " )

endif()   



if( INSTANTIATE_DOUBLE STREQUAL "yes" )

   AddCompilerFlag( "-DINSTANTIATE_DOUBLE " )

endif()   



if( INSTANTIATE_LONG_DOUBLE STREQUAL "yes" )

   AddCompilerFlag( "-DINSTANTIATE_LONG_DOUBLE " )

endif()   



ENABLE_TESTING()

INCLUDE( Dart )

set( CXX_TEST_FLAGS "-fprofile-arcs -ftest-coverage" )

set( LD_TEST_FLAGS "-lgcov -coverage" )

ChangeLog

+16 −0
Original line number Diff line number Diff line 


        * tnlBoundaryConditionsSetter was implemented 

           - it allows to set boundary conditions to given function

           - in explicit solvers, it must be called explicitly now after calling tnlExplicitUpdater



2015-12-25 Tomas Oberhuber  <tomas.oberhuber@fjfi.cvut.cz>

        * significant changes in grids

            - the central structure is now grid entity rather than grid itself

            - specialization of cells for cross stencils was implemented -- they store indexes of neighbhour cells

            - it currently does not work with nvcc compiler

            - grid traversers takes entity type instead of entity dimensions as a templated argument

        * mesh function was implemented

        * boundary conditions were refactored a simplified

            - there is no need to have analytic and discrete types of boundary conditions

        * tnl-quickstart does not generate correct code now



2012-10-05  Tomas Oberhuber  <tomas.oberhuber@fjfi.cvut.cz>

 

	* src/mesh/detail/container.h:

TODO

+40 −5
Original line number Diff line number Diff line 
TODO: v tnlMeshResolver se provadi preklad pro vsechny mozne sablonove parametry => prorezat

TODO:

 - implementovat tnlMixedGridBoundaryConditions, kde by se pro kazdou stranu gridu definoval jiny zvlastni typ

   okrajovych podminek

 - dalo by se tim resit i skladani zpetnych a doprednych diferenci u nelinearni difuze, kdy je potreba napr. dopredne diference

   vycislit i na leve a dolni hranici 2D gridu



TODO:

 - implementovat tuple pro snazsi a snad efektoivnejsi prenos dat na GPU

 - nebylo by nutne definovat pomocne datove structury pro traverser

 - data by se na hostu preskupila do souvisleho bloku dat a ten se prenesl najednou





TODO:

 - zavest namespaces



TODO: CUDA unified memory

 - pretizit operator new s cudaMallocManaged, pak by bylo mozne vytvaret CUDA objekty pristupne pro host a device

 - v TNL solveru by pak vlastne jen stacilo vytvaret objekty pomoci new

 - zrejme bude nutne pretizit i delete

 - pokud jde o MeshDependentData, stacilo by, aby uzivatel pretizil operator new a delete. Pokud by to neudelal, mohlo by 

se s nimi pracovat postaru

 - bylo by dobre to obalit unique poinetry, aby se nemusela delat dealokace rucne



TODO: shared pointery

 - mohli bysme pomoci nich odstranit Shared objekty

 - asi by bylo lepsi datcounter z shared pointeru primo do array a tento counter by se alokoval az po porvnim sdileni dat

 - diky tomu by se array mohlo vytvaret i na gpu bez nutnosti dynamicke alokace, jen by nebylo mozne delat bind (nebo nejaky zjednoduseny)



TODO: Mesh

 * vsechny traits zkusit presunout do jednotneho MeshTraits, tj. temer MeshConfigTraits ale pojmenovat jako MeshTraits

 * omezit tnlDimesnionsTag - asi to ale nepujde

   - ale pozor na konstrukce jako BaseType::superentityIdsArray< SuperDimensionTag >( DimensionsTag ); ( v tnlMesh.h)

 * prejmenovat Tagy v topologies na Topology zrejme

 * zrusit tnlStorageTraits



TODO: napsat FunctionDiscretizer pro jednotne rozhrani RightHandSide



TODO: doplnit mesh travelsals pro jine mesh entity nez cell

TODO: implementace maticovych resicu

      * Gaussova eliminace

      * SOR metoda
@@ -10,8 +41,12 @@ TODO: implementace maticovych resicu 
      * TFQMR metoda

      * IDR metody 



TODO: Nahradit sablonovy parametr dimenze sitove entity za typ entity. V pripade hran gridu, by ty v sobe mohly mit i orientaci.

      Asi by to bylo vyhodne i pro site se smisenym typem entit. 

TODO: Nahradit sablonovy parametr dimenze sitove entity za typ entity. Pak by se mohlo zkusit, napriklad u gridu

      odvozovat entity, ktere obsahuji predpocitane indexy pro dopredne, zpetne, nebo centralni diference. Uzivatel

      by si mohl definovat vlastni entity. Mohlo by to zvysit efektivitu.

      U nestrukturovanych siti by se do entit mohly doplnovat ukazatele na struktury s dalsimi informacemi jako 

      objemy nebo delky entyt apod.

      za tim ucelem nahradit setIndex v grdi entity za update(), aby to bylo obecnejsi



TODO: implementovat tridu tnlFileName pro generovani jmen souboru

doc/Makefile

0 → 100644
+177 −0
Original line number Diff line number Diff line 
# 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 gettext



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 "  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)"



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/TNL.qhcp"

	@echo "To view the help file:"

	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TNL.qhc"



devhelp:

	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

	@echo

	@echo "Build finished."

	@echo "To view the help file:"

	@echo "# mkdir -p $$HOME/.local/share/devhelp/TNL"

	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TNL"

	@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."



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."