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

21 lines
918 B
CMake
Raw Normal View History

Update documentation for compliance with doxygen 1.8.5. When upgrading from doxygen 1.5.x to 1.8.5 the way the documentation is generated has underwent many changes, particularly in the headers. * Change: In <header.html>, must include the javascripts <jquery.js> and <dynsections.js>. * In <CMakeLists.txt>, as the header is customized, doxygen seems not copy some files like the javascripts and some images (open.png, closed.png). So we copy them from doxygen installation and make the CMakeLists.txt install them. I hope they will not change too much in the future. * In <doxyfile>, disable markdown support as it do not interpret correctly the formating we already adopted (with a left margin to put command into). Use HTML_EXTRA_STYLESHEET instead of HTML_STYLESHEET. Enable the index (DISABLE_INDEX=NO), for the top header. Enable dot for inheritance diagram. Set the EXAMPLE_PATH=. to include the synthetic hierarchy. Correct the tag inclusion (faulty path in some places). * In <SoC.css>, create style for the new header generated by doxygen. * In the documentation, move the synthetic hierarchy into a module.
2014-05-13 09:30:41 -05:00
# -*- mode: CMAKE; explicit-buffer-name: "CMakeLists.txt<hurricane/doc/viewer>" -*-
* ./hurricane/doc/hviewer : - Embryo of documentation for the hviewer widget.
2008-07-02 10:13:40 -05:00
Migrating doc from Sphinx towards Pelican. * Change: In documentation, now generate the overall documentation using Pelican instead of Sphinx. This allows to have an unified approach between the coriolis.lip6.fr website and the local documentation. So we keep using "only" two doc generators: doxygen & Pelican.
2020-02-03 10:44:15 -06:00
set ( htmlInstallDir share/doc/coriolis2/en/html/doc/viewer )
* All tools: - Change: adopt a tree layout compliant with the UNIX FHS. * includes under TOP/include/coriolis2. * shared datas under TOP/shared/coriolis2. * docs under TOP/share/doc/coriolis2. * configuration under TOP/etc/coriolis2 * ./crlcore: - Change: In Environment, comply to the new tree layout, search configuration files under TOP/etc/coriolis2/. * ./knik: - Change: In flute, comply to the new tree layout, get the "POW*.dat" files from TOP/share/coriolis2/flute-2.4.
2010-05-18 07:53:00 -05:00
set ( latexInstallDir share/doc/coriolis2/en/latex/viewer )
Update documentation for compliance with doxygen 1.8.5. When upgrading from doxygen 1.5.x to 1.8.5 the way the documentation is generated has underwent many changes, particularly in the headers. * Change: In <header.html>, must include the javascripts <jquery.js> and <dynsections.js>. * In <CMakeLists.txt>, as the header is customized, doxygen seems not copy some files like the javascripts and some images (open.png, closed.png). So we copy them from doxygen installation and make the CMakeLists.txt install them. I hope they will not change too much in the future. * In <doxyfile>, disable markdown support as it do not interpret correctly the formating we already adopted (with a left margin to put command into). Use HTML_EXTRA_STYLESHEET instead of HTML_STYLESHEET. Enable the index (DISABLE_INDEX=NO), for the top header. Enable dot for inheritance diagram. Set the EXAMPLE_PATH=. to include the synthetic hierarchy. Correct the tag inclusion (faulty path in some places). * In <SoC.css>, create style for the new header generated by doxygen. * In the documentation, move the synthetic hierarchy into a module.
2014-05-13 09:30:41 -05:00
set ( doxExtras closed.png
open.png
Correct the doxygen CSS to be compliant with 1.8.13+.
2017-12-02 20:19:10 -06:00
tabs.css
Update documentation for compliance with doxygen 1.8.5. When upgrading from doxygen 1.5.x to 1.8.5 the way the documentation is generated has underwent many changes, particularly in the headers. * Change: In <header.html>, must include the javascripts <jquery.js> and <dynsections.js>. * In <CMakeLists.txt>, as the header is customized, doxygen seems not copy some files like the javascripts and some images (open.png, closed.png). So we copy them from doxygen installation and make the CMakeLists.txt install them. I hope they will not change too much in the future. * In <doxyfile>, disable markdown support as it do not interpret correctly the formating we already adopted (with a left margin to put command into). Use HTML_EXTRA_STYLESHEET instead of HTML_STYLESHEET. Enable the index (DISABLE_INDEX=NO), for the top header. Enable dot for inheritance diagram. Set the EXAMPLE_PATH=. to include the synthetic hierarchy. Correct the tag inclusion (faulty path in some places). * In <SoC.css>, create style for the new header generated by doxygen. * In the documentation, move the synthetic hierarchy into a module.
2014-05-13 09:30:41 -05:00
)
* ./hurricane/doc/hviewer : - Embryo of documentation for the hviewer widget.
2008-07-02 10:13:40 -05:00
Typo in CMakeLists.txt : AND instead of "and".
2018-06-06 16:22:18 -05:00
if(BUILD_DOC AND DOXYGEN_FOUND)
Correct the doxygen CSS to be compliant with 1.8.13+.
2017-12-02 20:19:10 -06:00
add_custom_target ( viewerDoc ALL
cd ${HURRICANE_SOURCE_DIR}/doc/viewer
&& ${DOXYGEN_EXECUTABLE} doxyfile
&& cp -f ${doxExtras} html
)
Add a fully generated documentation in the git repository. * Change: In all tools supplying documentation, as we use some specific software to create the doc, they may not be available, or worse, be and incompatible version. So, by default, we install the files shipped with the git repository. To force a full doc rebuild, use the "--doc" flag of ccb.py.
2018-06-06 11:42:26 -05:00
endif()
* ./hurricane/doc/hviewer : - Embryo of documentation for the hviewer widget.
2008-07-02 10:13:40 -05:00
install ( DIRECTORY html/ DESTINATION ${htmlInstallDir} )
install ( DIRECTORY latex/ DESTINATION ${latexInstallDir} )
install ( FILES asimbook.cls DESTINATION ${latexInstallDir} )