Skip to content

Commit 000ba6e

Browse files
sipmasipma
committed
DOC: sphinx documentation files
1 parent ab4d006 commit 000ba6e

File tree

144 files changed

+2298
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+2298
-0
lines changed

‎docs/source/Makefile‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = .
8+
BUILDDIR = _build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/source/_static/css/codehawkc-html.css‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
body {
2+
font-family: "Helvetica Neue", sans-serif;
3+
}
4+
5+
#sumtype {
6+
font-family: Arial, Helvetic, sans-serif;
7+
border-collapse: collapse;
8+
width: 100%;
9+
}
10+
11+
#sumtype tr:nth-child(even){background-color: #f2f2f2;}
12+
13+
#sumtype tr:hover {background-color: #ddd;}
14+
15+
#sumtype th {
16+
padding-top: 12px;
17+
padding-bottom: 12px;
18+
text-align: left;
19+
background-color: #FF9900;
20+
color: black;
21+
}
22+
23+
#sumtype caption {
24+
font-style: italic;
25+
padding-top: 8px;
26+
padding-bottom: 12px;
27+
}
28+
29+
.tooltip {
30+
position: relative;
31+
display: inline-block;
32+
border-bottom: 1px dotted black;
33+
}
34+
35+
.tooltip .tooltiptext {
36+
visibility: hidden;
37+
background-color: #2e86c1;
38+
width: max-content;
39+
max-width: 500px;
40+
color: #fff;
41+
text-align: center;
42+
border-radius: 6px;
43+
padding: 5px 5px;
44+
45+
/* Position the tooltip */
46+
position: absolute;
47+
z-index: 1;
48+
}
49+
50+
.tooltip:hover .tooltiptext {
51+
visibility: visible;
52+
}
53+
54+
55+
56+
table {
57+
margin-left: 20px;
58+
margin-right: 20px;
59+
border: thin solid black;
60+
caption-side: bottom;
61+
}
62+
63+
td, th {
64+
border: thin dotted gray;
65+
padding: 10px;
66+
vertical-align: middle;
67+
}
68+
69+
td:description {
70+
vertical-align: center;
71+
}
72+
73+

‎docs/source/_templates/custom-class-template.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:members:
7+
:show-inheritance:
8+
:inherited-members:
9+
:special-members: __call__, __add__, __mul__
10+
11+
{% block methods %}
12+
{% if methods %}
13+
.. rubric:: {{ _('Methods') }}
14+
15+
.. autosummary::
16+
:nosignatures:
17+
{% for item in methods %}
18+
{%- if not item.startswith('_') %}
19+
~{{ name }}.{{ item }}
20+
{%- endif -%}
21+
{%- endfor %}
22+
{% endif %}
23+
{% endblock %}
24+
25+
{% block attributes %}
26+
{% if attributes %}
27+
.. rubric:: {{ _('Attributes') }}
28+
29+
.. autosummary::
30+
{% for item in attributes %}
31+
~{{ name }}.{{ item }}
32+
{%- endfor %}
33+
{% endif %}
34+
{% endblock %}

‎docs/source/_templates/custom-module-template.rst‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. automodule:: {{ fullname }}
4+
5+
{% block attributes %}
6+
{% if attributes %}
7+
.. rubric:: Module attributes
8+
9+
.. autosummary::
10+
:toctree:
11+
{% for item in attributes %}
12+
{{ item }}
13+
{%- endfor %}
14+
{% endif %}
15+
{% endblock %}
16+
17+
{% block functions %}
18+
{% if functions %}
19+
.. rubric:: {{ _('Functions') }}
20+
21+
.. autosummary::
22+
:toctree:
23+
:nosignatures:
24+
{% for item in functions %}
25+
{{ item }}
26+
{%- endfor %}
27+
{% endif %}
28+
{% endblock %}
29+
30+
{% block classes %}
31+
{% if classes %}
32+
.. rubric:: {{ _('Classes') }}
33+
34+
.. autosummary::
35+
:toctree:
36+
:template: custom-class-template.rst
37+
:nosignatures:
38+
{% for item in classes %}
39+
{{ item }}
40+
{%- endfor %}
41+
{% endif %}
42+
{% endblock %}
43+
44+
{% block exceptions %}
45+
{% if exceptions %}
46+
.. rubric:: {{ _('Exceptions') }}
47+
48+
.. autosummary::
49+
:toctree:
50+
{% for item in exceptions %}
51+
{{ item }}
52+
{%- endfor %}
53+
{% endif %}
54+
{% endblock %}
55+
56+
{% block modules %}
57+
{% if modules %}
58+
.. autosummary::
59+
:toctree:
60+
:template: custom-module-template.rst
61+
:recursive:
62+
{% for item in modules %}
63+
{{ item }}
64+
{%- endfor %}
65+
{% endif %}
66+
{% endblock %}

‎docs/source/chc.api.ApiAssumption.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
chc.api.ApiAssumption module
2+
----------------------------
3+
4+
.. automodule:: chc.api.ApiAssumption
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/chc.api.ApiParameter.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
chc.api.ApiParameter module
2+
---------------------------
3+
4+
Base class and subclasses:
5+
^^^^^^^^^^^^^^^^^^^^^^^^^^
6+
7+
.. autosummary::
8+
chc.api.ApiParameter.ApiParameter
9+
chc.api.ApiParameter.APFormal
10+
chc.api.ApiParameter.APGlobal
11+
12+
.. automodule:: chc.api.ApiParameter
13+
:members:
14+
:undoc-members:
15+
:show-inheritance:

‎docs/source/chc.api.CFileContracts.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
chc.api.CFileContracts module
2+
-----------------------------
3+
4+
.. automodule:: chc.api.CFileContracts
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/chc.api.CFunctionContract.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
chc.api.CFunctionContract module
2+
--------------------------------
3+
4+
.. automodule:: chc.api.CFunctionContract
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/chc.api.CGlobalContract.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
chc.api.CGlobalContract module
2+
------------------------------
3+
4+
.. automodule:: chc.api.CGlobalContract
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/chc.api.ContractAssumption.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
chc.api.ContractAssumption module
2+
---------------------------------
3+
4+
.. automodule:: chc.api.ContractAssumption
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)