riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/documentation/CMakeLists.txt

95 lines
4.2 KiB
CMake
Raw Normal View History

Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
# -*- mode: CMAKE; explicit-buffer-name: "CMakeLists.txt<documentation>" -*-
Starting to implement support for Windows/Cygwin. * New: In all to CMakeLists.txt, disable the warning about deprecated WIN32 under cygwin. * New: In boostrap, in ccb.py, coriolisEnv.py and builder/Configuration.py add recognition in uname for the values returned under Windows/Cygwin. * New: In Documenation, in UsersGuide.rst add some informations about Cygwin and a section for the devel branch.
2014-07-13 06:14:49 -05:00
set(CMAKE_LEGACY_CYGWIN_WIN32 0)
Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
project(DOCUMENTATION)
cmake_minimum_required(VERSION 2.4.0)
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
option(BUILD_DOC "Build the documentation (html+pdf)" OFF)
Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
Compliance with g++ 4.8.1, support for devtoolset-2 Details: * New: in <bootstrap>: add support for devtoolset-2 in ccb. Run the cmake commands through 'scl', set shell environment variables BOOST_INCLUDEDIR & BOOST_LIBRARYDIR and disable the default system path search. * Change: In various flex scanners add the %nounput to suppress compiler warnings. * Change: Little cleanup for g++ 4.8.1 as it's more strict. * Change: In various top CMakeLists.txt, suppress extraneous '/' after DESTDIR.
2014-03-15 04:47:37 -05:00
list(INSERT CMAKE_MODULE_PATH 0 "${DESTDIR}$ENV{CORIOLIS_TOP}/share/cmake/Modules/")
Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
find_package(Bootstrap REQUIRED)
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
find_package(Sphinx REQUIRED)
Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
setup_project_paths(CORIOLIS)
set_cmake_policies()
#if(BUILD_DOC)
# include(UseLATEX)
#endif(BUILD_DOC)
add_subdirectory(examples)
if(BUILD_DOC)
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
set ( htmlInstallDir share/doc/coriolis2/en/html/main )
set ( pdfInstallDir share/doc/coriolis2/en/pdf/main )
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
set ( pythonCppRst PythonCpp/pdfHeader.rst
PythonCpp/Introduction.rst
PythonCpp/Configuration.rst
PythonCpp/DBoStandalone.rst
PythonCpp/DBoHierarchy.rst
PythonCpp/NonDBo.rst
PythonCpp/DbU.rst
PythonCpp/Name.rst )
set ( usersGuideRst UsersGuide/pdfHeader.rst
UsersGuide/LicenseCredits.rst
UsersGuide/Releases.rst
UsersGuide/Installation.rst
UsersGuide/Configuration.rst
UsersGuide/ViewerTools.rst
UsersGuide/ScriptsPlugins.rst )
set ( rdsRst RDS/pdfHeader.rst
RDS/RDSpage.rst )
add_custom_target ( doc_HTML ALL
cd ${DOCUMENTATION_SOURCE_DIR}
&& rm -rf _build
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
&& sphinx-build -b html -d _build/doctrees . _build/html
DEPENDS etc/definitions.rst
_static/SoC.css
_static/www-SoC.css
_static/SoC-ReST.css
_static/pygments.css
CrlCore/CrlCore.rst
DpGen/DpGen.rst
Hurricane/Hurricane.rst
Patterns/Patterns.rst
Stratus/Stratus.rst
Unicorn/Unicorn.rst
Viewer/Viewer.rst
${usersGuideRst} UsersGuide/index.rst
${pythonCppRst} PythonCpp/index.rst
${rdsRst} RDS/index.rst
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
)
add_custom_target ( pdf_UsersGuide ALL
cd ${DOCUMENTATION_SOURCE_DIR}/UsersGuide
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
&& ../etc/doPdf.sh ${usersGuideRst} UsersGuide.rst
DEPENDS etc/definitions.rst
etc/SoC-ReST.tex
${usersGuideRst} )
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
add_custom_target ( pdf_PythonCpp ALL
cd ${DOCUMENTATION_SOURCE_DIR}/PythonCpp
&& ../etc/doPdf.sh ${pythonCppRst} PythonCpp.rst
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
DEPENDS etc/definitions.rst
etc/SoC-ReST.tex
${pythonCppRst} )
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
add_custom_target ( pdf_RDS ALL
cd ${DOCUMENTATION_SOURCE_DIR}/RDS
&& ../etc/doPdf.sh ${rdsRst} RDS.rst
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
DEPENDS etc/definitions.rst
etc/SoC-ReST.tex
${pythonCppRst} )
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
install ( DIRECTORY _build/html/ DESTINATION ${htmlInstallDir} )
install ( FILES RDS/RDS.pdf
PythonCpp/PythonCpp.pdf
UsersGuide/UsersGuide.pdf DESTINATION ${pdfInstallDir} )
Documentation restructuration Documentation restructuration: * Bug: in <hurricane>: bad figure for transf-R1. * Change, in <kite>: Remove deprecated configuration variables. * New: documentation <tool> to regroup all documentation not directly related to one tool. * Change, in <crlcore>, move the user's guide and the top doc index into <documentation>. * New, in <documenation>: added Python script demo based on AM2901.
2014-03-10 08:06:31 -05:00
endif(BUILD_DOC)