coriolis/documentation/deprecated/Hurricane/Hurricane.rst

.. -*- Mode: rst -*-

.. include:: ../etc/definitions.rst


=====================
Hurricane Reference
=====================

The Hurricane C++ API reference is generated by Doxygen_ and is
available here: `Hurricane <../../hurricane/index.html>`_
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			`.. -- Mode: rst --`

			`.. include:: ../etc/definitions.rst`


			`=====================`
			`Hurricane Reference`
			`=====================`

			`The Hurricane C++ API reference is generated by Doxygen_ and is`
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			available here: `Hurricane <../../hurricane/index.html>`_