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

37 lines
746 B
ReStructuredText
Raw Normal View History

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; explicit-buffer-name: "index.rst<root>" -*-
.. Coriolis documentation master file, created by
sphinx-quickstart on Mon Jul 10 15:08:36 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Coriolis's documentation!
====================================
Contents:
.. toctree::
UsersGuide/index.rst
Stratus/Stratus.rst
DpGen/DpGen.rst
Patterns/Patterns.rst
Hurricane/Hurricane.rst
Viewer/Viewer.rst
CrlCore/CrlCore.rst
More doc unification and cleanup.
2017-07-17 12:12:18 -05:00
Katabatic/Katabatic.rst
Kite/Kite.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
Unicorn/Unicorn.rst
PythonCpp/index.rst
RDS/index.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`