This is an archive of the discontinued LLVM Phabricator instance.

Differential D25968

[Acxxel] Generate documentation for website
AcceptedPublic

Authored by jhen on Oct 25 2016, 2:48 PM.

Details

Reviewers
jlebar
Summary

Set up the build to generate documentation that will appear on the Acxxel
website at parallel-libs.llvm.org.

Diff Detail

Event Timeline

jhen updated this revision to Diff 75799.Oct 25 2016, 2:48 PM
jhen retitled this revision from to [Acxxel] Generate documentation for website.
jhen updated this object.
Herald added subscribers: jlebar, mgorny, beanz. · View Herald TranscriptOct 25 2016, 2:48 PM
jlebar accepted this revision.Oct 25 2016, 2:51 PM
jlebar added a reviewer: jlebar.
This revision is now accepted and ready to land.Oct 25 2016, 2:51 PM
jhen added a comment.Oct 25 2016, 2:56 PM

I'm contacting Tanya Lattner to make sure I have set the hooks up correctly for this documentation to be generated and published automatically by the standard LLVM doc scripts. I will wait to check this in until I hear back.

Revision Contents

Diff 75799

CMakeLists.txt

cmake_minimum_required(VERSION 3.1) cmake_minimum_required(VERSION 3.1)
add_subdirectory(acxxel)

acxxel/CMakeLists.txt

cmake_minimum_required(VERSION 3.1) cmake_minimum_required(VERSION 3.1)
option(ACXXEL_ENABLE_UNIT_TESTS "enable acxxel unit tests" ON) option(ACXXEL_ENABLE_UNIT_TESTS "enable acxxel unit tests" ON)
option(ACXXEL_ENABLE_EXAMPLES "enable acxxel examples" OFF) option(ACXXEL_ENABLE_EXAMPLES "enable acxxel examples" OFF)
option(ACXXEL_ENABLE_DOXYGEN "enable Doxygen for acxxel" OFF)
option(ACXXEL_ENABLE_CUDA "enable CUDA for acxxel" ON) option(ACXXEL_ENABLE_CUDA "enable CUDA for acxxel" ON)
option(ACXXEL_ENABLE_OPENCL "enable OpenCL for acxxel" ON) option(ACXXEL_ENABLE_OPENCL "enable OpenCL for acxxel" ON)
option(
ACXXEL_INCLUDE_DOCS
"Generate build targets for the acxxel docs"
${LLVM_INCLUDE_DOCS})
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
project(acxxel) project(acxxel)
set(ACXXEL_BUILT_STANDALONE TRUE)
endif()
if(ACXXEL_ENABLE_CUDA) if(ACXXEL_ENABLE_CUDA)
find_package(CUDA REQUIRED) find_package(CUDA REQUIRED)
include_directories(${CUDA_INCLUDE_DIRS}) include_directories(${CUDA_INCLUDE_DIRS})
find_library(CUDA_DRIVER_LIBRARY cuda) find_library(CUDA_DRIVER_LIBRARY cuda)
if(NOT CUDA_DRIVER_LIBRARY) if(NOT CUDA_DRIVER_LIBRARY)
message(FATAL_ERROR "could not find libcuda, is the CUDA driver installed on your system?") message(
FATAL_ERROR
"could not find libcuda, is the CUDA driver installed on your system?")
endif(NOT CUDA_DRIVER_LIBRARY) endif(NOT CUDA_DRIVER_LIBRARY)
set(ACXXEL_CUDA_SOURCES cuda_acxxel.cpp) set(ACXXEL_CUDA_SOURCES cuda_acxxel.cpp)
set(ACXXEL_CUDA_LIBRARIES ${CUDA_DRIVER_LIBRARY} ${CUDA_LIBRARIES}) set(ACXXEL_CUDA_LIBRARIES ${CUDA_DRIVER_LIBRARY} ${CUDA_LIBRARIES})
endif(ACXXEL_ENABLE_CUDA) endif(ACXXEL_ENABLE_CUDA)
if(ACXXEL_ENABLE_OPENCL) if(ACXXEL_ENABLE_OPENCL)
find_package(OpenCL REQUIRED) find_package(OpenCL REQUIRED)
include_directories(${OpenCL_INCLUDE_DIRS}) include_directories(${OpenCL_INCLUDE_DIRS})
Show All 30 Lines
if(ACXXEL_ENABLE_UNIT_TESTS) if(ACXXEL_ENABLE_UNIT_TESTS)
enable_testing() enable_testing()
find_package(GTest REQUIRED) find_package(GTest REQUIRED)
include_directories(${GTEST_INCLUDE_DIRS}) include_directories(${GTEST_INCLUDE_DIRS})
find_package(Threads) find_package(Threads)
add_subdirectory(tests) add_subdirectory(tests)
endif() endif()
if(ACXXEL_ENABLE_DOXYGEN) if(ACXXEL_INCLUDE_DOCS)
find_package(Doxygen REQUIRED) add_subdirectory(docs)
configure_file(Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(
acxxel-doc
${DOXYGEN_EXECUTABLE}
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY
${CMAKE_CURRENT_BINARY_DIR}
COMMENT
"Generating acxxel API documentation with Doxygen"
VERBATIM)
endif() endif()

acxxel/Doxyfile.in

  • This file was moved to acxxel/docs/Doxyfile.in.

acxxel/customdoxygen.css

  • This file was moved to acxxel/docs/customdoxygen.css.

acxxel/docs/CMakeLists.txt

  • This file was added.
if(ACXXEL_BUILT_STANDALONE)
find_package(Doxygen REQUIRED)
endif()
if(DOXYGEN_FOUND)
if(LLVM_ENABLE_DOXYGEN OR ACXXEL_BUILT_STANDALONE)
configure_file(Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(
doxygen-acxxel
COMMAND
${DOXYGEN_EXECUTABLE}
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY
${CMAKE_CURRENT_BINARY_DIR}
COMMENT
"Generating acxxel doxygen documentation"
VERBATIM)
if(LLVM_BUILD_DOCS)
add_dependencies(doxygen doxygen-acxxel)
endif()
if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
install(
DIRECTORY
${CMAKE_CURRENT_BINARY_DIR}/docs/html
DESTINATION
docs/html)
endif()
endif()
endif(DOXYGEN_FOUND)

acxxel/docs/Doxyfile.in

  • This file was moved from acxxel/Doxyfile.in.
Show First 20 Lines • Show All 737 Lines • ▼ Show 20 Lines
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# The INPUT tag is used to specify the files and/or directories that contain # The INPUT tag is used to specify the files and/or directories that contain
# documented source files. You may enter file names like myfile.cpp or # documented source files. You may enter file names like myfile.cpp or
# directories like /usr/src/myproject. Separate the files or directories with # directories like /usr/src/myproject. Separate the files or directories with
# spaces. # spaces.
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = @CMAKE_CURRENT_SOURCE_DIR@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@/..
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
# documentation (see: http://www.gnu.org/software/libiconv) for the list of # documentation (see: http://www.gnu.org/software/libiconv) for the list of
# possible encodings. # possible encodings.
# The default value is: UTF-8. # The default value is: UTF-8.
▲ Show 20 Lines • Show All 51 Lines • ▼ Show 20 Lines
# exclude all test directories use the pattern */test/* # exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS = EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or directories # The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include # that contain example code fragments that are included (see the \include
# command). # command).
EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/../examples
# If the value of the EXAMPLE_PATH tag contains directories, you can use the # If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
# *.h) to filter out the source-files in the directories. If left blank all # *.h) to filter out the source-files in the directories. If left blank all
# files are included. # files are included.
EXAMPLE_PATTERNS = EXAMPLE_PATTERNS =
▲ Show 20 Lines • Show All 712 Lines • ▼ Show 20 Lines
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the LaTeX output # Configuration options related to the LaTeX output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
# The default value is: YES. # The default value is: YES.
GENERATE_LATEX = YES GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. # it.
# The default directory is: latex. # The default directory is: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES. # This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex LATEX_OUTPUT = latex
▲ Show 20 Lines • Show All 752 Lines • Show Last 20 Lines

acxxel/docs/customdoxygen.css

  • This file was moved from acxxel/customdoxygen.css.
body { body {
background-color: #e0e0eb; background-color: #e0e0eb;
} }
div.header { div.header {
margin-left: auto; margin-left: auto;
margin-right: auto; margin-right: auto;
max-width: 60em; max-width: 60em;
padding-left: 2em; padding-left: 2em;
padding-right: 2em; padding-right: 2em;
} }
div.contents { div.contents {
margin-left: auto; margin-left: auto;
margin-right: auto; margin-right: auto;
max-width: 60em; max-width: 60em;
background-color: white; background-color: white;
padding: 2em; padding: 2em;
border-radius: 1em; border-radius: 1em;
} }
acxxel/docs/Doxyfile.in