Skip to content

Commit cc1353d

Browse files
authored
Improved documentation (#6)
1 parent 478d501 commit cc1353d

28 files changed

+12637
-2085
lines changed

docs/_static/style.css

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
body {
22
color: #444444 !important;
3+
font-size: 16px !important;
34
}
45

56
h1 {
67
font-size: 40px !important;
78
}
89
h2 {
9-
font-size: 32px !important;
10+
font-size: 36px !important;
1011
}
1112
h3 {
12-
font-size: 24px !important;
13+
font-size: 32px !important;
1314
}
1415
h4 {
15-
font-size: 18px !important;
16+
font-size: 24px !important;
1617
}
1718
h5 {
18-
font-size: 14px !important;
19+
font-size: 18px !important;
1920
}
2021
h6 {
21-
font-size: 10px !important;
22+
font-size: 16px !important;
2223
}
2324

2425
footer a {
@@ -29,7 +30,7 @@ a.reference {
2930
}
3031

3132
blockquote p {
32-
font-size: 14px !important;
33+
font-size: 18px !important;
3334
}
3435

3536
blockquote {
@@ -330,7 +331,7 @@ div.rendered_html table {
330331
border-collapse: collapse;
331332
border-spacing: 0;
332333
color: black;
333-
font-size: 12px;
334+
font-size: 16px;
334335
table-layout: fixed;
335336
}
336337
div.rendered_html thead {

docs/api/gc_pcsaft.rst

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/api/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Functionalities that make working with the code easier.
1212
:maxdepth: 1
1313

1414
si
15-
num_dual
1615

1716
.. _equations_of_state:
1817

docs/api/num_dual.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/api/user_defined.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,11 @@ User defined equation of state
77
A :class:`UserDefinedEos` can be used to implement an equation of state as Python class object.
88
See :doc:`this example notebook </examples/user_defined_eos>` to learn more.
99

10-
.. currentmodule:: feos.user_defined
11-
12-
Utility
13-
~~~~~~~
14-
15-
.. autosummary::
16-
:toctree: generated/
17-
18-
1910
Equation of state
2011
~~~~~~~~~~~~~~~~~
2112

13+
.. currentmodule:: feos.user_defined
14+
2215
.. autosummary::
2316
:toctree: generated/
2417

docs/examples/index.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,21 @@
33
Python Examples
44
===============
55

6+
Utility
7+
-------
8+
69
.. toctree::
710
:maxdepth: 1
811

9-
user_defined_eos
1012
DualNumbers
13+
working_with_units
14+
15+
PC-SAFT
16+
-------
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
21+
pcsaft_working_with_parameters
22+
pcsaft_state
23+
pcsaft_phase_diagram

0 commit comments

Comments
 (0)