coriolis/hurricane/doc/hurricane
Jean-Paul Chaput f29e65d908
Build doc pelican (#11)
* Switch back to a generated version of the documentation.

Dependencies for the documentation generation have been added to poetry.
As Pelican is a Python tool, that makes sense.

Note to myself: To generate the doc with ccb.py we *need* to be inside
                the Python virtual env generated by Poetry. Instead of
		relying of a default one, provide one of our own
		(coriolis-venv) and make poetry run in it.

* Top builder.py now generated the doc.

* Forgot to remove generated PDFs in the documentation.

* A bit of cleanup on the README.rst

* Forgot the logo. Try to use code-block directive in README.

* Still typo in the logo path.

* One more trial at setting the image position.

* OK. That's enough for the logo.

* Problems with code-block.

* Voila!

* Build inside a venv and use poetry in the top level Makefile.

* Remove doxygen generated docs.

* More doc cleanup in oroshi.
2023-08-01 15:43:21 +02:00
..
images Full update of the generated documentation. 2020-04-27 14:14:03 +02:00
xml Added management of Python attributes on DBo. 2022-08-13 17:46:47 +02:00
BasicLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
Box.dox * All Tools: 2012-11-16 12:48:38 +00:00
CMakeLists.txt Full update of the generated documentation. 2020-04-27 14:14:03 +02:00
Cell.dox Clarify semantic of flatten Collections (walkthrough). 2020-03-10 12:10:53 +01:00
Collection.dox Policy CMP0022 for CMake. Forgotten library in Unicorn link. 2015-06-11 18:01:39 +02:00
Command.dox * All Tools: 2012-11-16 12:48:38 +00:00
Commons.dox Complete rewrite of the trace system (now a stream). 2016-05-17 23:00:06 +02:00
Component.dox * All Tools: 2012-11-16 12:48:38 +00:00
CompositeLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
Contact.dox Separate size check for Hurricane::Contact & Hurricane::Pin. 2020-12-02 19:12:27 +01:00
ContactLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
DBo.dox Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
DataBase.dox * All Tools: 2012-11-16 12:48:38 +00:00
DbU.dox Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
DebugSession.dox Anlog integration part I. Atomic devices support (transistors). 2018-10-01 16:52:17 +02:00
Diagonal.dox Full update of the generated documentation. 2020-04-27 14:14:03 +02:00
DiffusionLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
DoxygenLayout.xml * All Tools: 2012-11-16 12:48:38 +00:00
Editor.dox documentation in progress 2008-02-05 21:26:22 +00:00
Entity.dox * ./hurricane/src/hurricane: 2013-12-04 01:26:07 +00:00
Error.dox * All Tools: 2012-11-16 12:48:38 +00:00
Exception.dox * All Tools: 2012-11-16 12:48:38 +00:00
ExpandRules.dox documentation in progress 2008-02-05 21:26:22 +00:00
Filter.dox * All Tools: 2012-11-16 12:48:38 +00:00
Generalities.dox Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
GenericCollection.dox * All Tools: 2012-11-16 12:48:38 +00:00
GenericFilter.dox * All Tools: 2012-11-16 12:48:38 +00:00
GenericLocator.dox documentation in progress 2008-02-05 21:26:22 +00:00
Go.dox * All Tools: 2012-11-16 12:48:38 +00:00
Hook.dox * All Tools: 2012-11-16 12:48:38 +00:00
Horizontal.dox * All Tools: 2012-11-16 12:48:38 +00:00
Hurricane.dox Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
HyperNet.dox * ./hurricane: 2013-03-13 13:38:15 +00:00
Initializer.dox Implementation of DataBase native save/restore in JSON (step 2). 2016-01-21 00:25:39 +01:00
Instance.dox Merged QuadTrees in overlayed Cells (placed together). 2015-06-26 18:35:11 +02:00
Interruption.dox * All Tools: 2012-11-16 12:48:38 +00:00
Interval.dox * All Tools: 2012-11-16 12:48:38 +00:00
JsonObject.dox Implementation of DataBase native save/restore in JSON (step 3). 2016-02-21 11:02:50 +01:00
JsonSupport.dox Implementation of DataBase native save/restore in JSON (step 3). 2016-02-21 11:02:50 +01:00
Layer.dox * All Tools: 2012-11-16 12:48:38 +00:00
Library.dox * All Tools: 2012-11-16 12:48:38 +00:00
ListCollection.dox * All Tools: 2012-11-16 12:48:38 +00:00
Locator.dox * All Tools: 2012-11-16 12:48:38 +00:00
MIGRATE.txt documentation in progress 2008-02-05 21:26:22 +00:00
MainView.dox * All Tools: 2012-11-16 12:48:38 +00:00
MapCollection.dox * All Tools: 2012-11-16 12:48:38 +00:00
MapView.dox * All Tools: 2012-11-16 12:48:38 +00:00
Name.dox * All Tools: 2012-11-16 12:48:38 +00:00
Net.dox Support for Uniquification. Rewrite of the Blif parser. 2015-04-25 16:52:18 +02:00
NotFilter.dox documentation in progress 2008-02-05 21:26:22 +00:00
Occurence.dox * All Tools: 2012-11-16 12:48:38 +00:00
Occurrence.dox * All Tools: 2012-11-16 12:48:38 +00:00
Pad.dox * All Tools: 2012-11-16 12:48:38 +00:00
Path.dox * All Tools: 2012-11-16 12:48:38 +00:00
PhysicalRule.dox Enhanced techno rule support. Inspector support bug fix. 2020-07-21 11:22:04 +02:00
Pin.dox documentation in progress 2008-02-05 21:26:22 +00:00
Plug.dox * All Tools: 2012-11-16 12:48:38 +00:00
Point.dox * All Tools: 2012-11-16 12:48:38 +00:00
Polygon.dox Full update of the generated documentation. 2020-04-27 14:14:03 +02:00
Primitive.dox documentation in progress 2008-02-05 21:26:22 +00:00
PrivateProperty.dox * All Tools: 2012-11-16 12:48:38 +00:00
Property.dox * All Tools: 2012-11-16 12:48:38 +00:00
PythonAttributes.dox Added management of Python attributes on DBo. 2022-08-13 17:46:47 +02:00
QuadTree.dox * All Tools: 2012-11-16 12:48:38 +00:00
Quark.dox * All Tools: 2012-11-16 12:48:38 +00:00
Query.dox * ./hurricane: 2013-03-13 13:38:15 +00:00
RecordHandles.dox * All Tools: 2012-11-16 12:48:38 +00:00
RegularLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
Relation.dox documentation in progress 2008-02-05 21:26:22 +00:00
RoutingPad.dox * ./hurricane/src/hurricane: 2013-12-04 01:26:07 +00:00
Rubber.dox * All Tools: 2012-11-16 12:48:38 +00:00
Segment.dox * All Tools: 2012-11-16 12:48:38 +00:00
SelectCommand.dox * All Tools: 2012-11-16 12:48:38 +00:00
SelectNetCommand.dox * All Tools: 2012-11-16 12:48:38 +00:00
Selector.dox documentation in progress 2008-02-05 21:26:22 +00:00
SetCollection.dox * All Tools: 2012-11-16 12:48:38 +00:00
SharedProperty.dox * All Tools: 2012-11-16 12:48:38 +00:00
Slice.dox * All Tools: 2012-11-16 12:48:38 +00:00
SoC.css Documentation cleanup & rebuild. 2020-11-12 14:22:31 +01:00
StandardPrivateProperty.dox * ./hurricane/doc/hurricane : 2009-04-03 14:21:04 +00:00
StandardRelation.dox documentation in progress 2008-02-05 21:26:22 +00:00
StandardSharedProperty.dox Implementation of DataBase native save/restore in JSON (step 2). 2016-01-21 00:25:39 +01:00
SubSetCollection.dox documentation in progress 2008-02-05 21:26:22 +00:00
SubTypeCollection.dox documentation in progress 2008-02-05 21:26:22 +00:00
Symbol.dox * All Tools: 2012-11-16 12:48:38 +00:00
Tabulation.dox * All Tools: 2012-11-16 12:48:38 +00:00
Technology.dox Enhanced techno rule support. Inspector support bug fix. 2020-07-21 11:22:04 +02:00
Transformation.dox Complete rewrite of the trace system (now a stream). 2016-05-17 23:00:06 +02:00
TransistorLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
UpdateSession.dox Complete rewrite of the trace system (now a stream). 2016-05-17 23:00:06 +02:00
VectorCollection.dox * All Tools: 2012-11-16 12:48:38 +00:00
Vertical.dox * All Tools: 2012-11-16 12:48:38 +00:00
ViaLayer.dox * All Tools: 2012-11-16 12:48:38 +00:00
View.dox * All Tools: 2012-11-16 12:48:38 +00:00
Warning.dox * All Tools: 2012-11-16 12:48:38 +00:00
ZoomCommand.dox * All Tools: 2012-11-16 12:48:38 +00:00
asimbook.cls documentation in progress 2008-02-05 21:26:22 +00:00
closed.png Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
customHierarchy.html Full update of the generated documentation. 2020-04-27 14:14:03 +02:00
customSummary.html * ./hurricane/src/hurricane: 2013-12-04 01:26:07 +00:00
doxyfile Added management of Python attributes on DBo. 2022-08-13 17:46:47 +02:00
doxygen.warn.log Regenerated documentation, just to check. 2023-02-22 15:02:39 +01:00
dynsections.js Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
footer.html Documentation cleanup & rebuild. 2020-11-12 14:22:31 +01:00
header.html Correct the doxygen CSS to be compliant with 1.8.13+. 2017-12-03 03:19:10 +01:00
header.tex documentation in progress 2008-02-05 21:26:22 +00:00
html.entry documentation in progress 2008-02-05 21:26:22 +00:00
jquery.js Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
open.png Update documentation for compliance with doxygen 1.8.5. 2014-05-13 16:30:41 +02:00
tabs.css Correct the doxygen CSS to be compliant with 1.8.13+. 2017-12-03 03:19:10 +01:00