Enable inheritance diagrams.

This commit is contained in:
Jakob Olesen
2016-02-09 08:11:20 -08:00
parent 19b4facbe0
commit a37005a1d4
3 changed files with 31 additions and 16 deletions

View File

@@ -38,6 +38,8 @@ extensions = [
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.graphviz',
'sphinx.ext.inheritance_diagram',
'cton_domain',
'cton_lexer',
]
@@ -293,3 +295,10 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Graphviz -------------------------------------------------
graphviz_output_format = 'svg'
inheritance_graph_attrs = dict(rankdir='TD')

View File

@@ -13,21 +13,28 @@ directory that has a global variable called ``instructions``. The basic
Cretonne instruction set described in :doc:`langref` is defined by the Python
module :mod:`cretonne.instrs`.
.. module:: cretonne
Types
=====
Concrete value types are represented as instances of :class:`cretonne.Type`. There are
subclasses to represent scalar and vector types.
.. autoclass:: cretonne.Type
.. autoclass:: cretonne.ScalarType
.. inheritance-diagram:: Type ScalarType VectorType IntType FloatType
:parts: 1
.. autoclass:: Type
.. autoclass:: ScalarType
:members:
.. autoclass:: cretonne.VectorType
.. autoclass:: VectorType
:members:
.. autoclass:: cretonne.IntType
.. autoclass:: IntType
:members:
.. autoclass:: cretonne.FloatType
.. autoclass:: FloatType
:members:
Predefined types
----------------
.. automodule:: cretonne.types
:members: