diff --git a/.gitignore b/.gitignore
index 9d176e6..7838f6b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -59,6 +59,8 @@ package-lock.json
._*
_*
!_custom_build/
+!docs/_templates/
+!docs/_static/
.Spotlight-V100
.Trashes
ehthumbs.db
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index b1b4aff..98134c1 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -22,6 +22,7 @@ sphinx:
python:
install:
- - requirements: requirements_docs.txt
- - method: setuptools
+ - method: pip
path: .
+ extra_requirements:
+ - docs
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
new file mode 100644
index 0000000..467fe7c
--- /dev/null
+++ b/docs/_static/custom.css
@@ -0,0 +1,16 @@
+/* Fix for Sphinx issue #11000: nature theme sidebar overflow with autodoc names */
+/* See: https://github.com/sphinx-doc/sphinx/issues/11000 */
+
+/* Increase sidebar width to accommodate longer names */
+div.documentwrapper div.bodywrapper {
+ margin-left: 250px;
+}
+
+div.document div.sphinxsidebar {
+ width: 250px;
+}
+
+/* Add scrollbar for overflowing content */
+div.sphinxsidebarwrapper div {
+ overflow: auto;
+}
diff --git a/docs/_templates/localtoc.html b/docs/_templates/localtoc.html
new file mode 100644
index 0000000..45d89ee
--- /dev/null
+++ b/docs/_templates/localtoc.html
@@ -0,0 +1,7 @@
+{# Custom local TOC template with depth limit #}
+{%- if display_toc %}
+
+
+ {{ toctree(maxdepth=1, collapse=False, includehidden=True) }}
+
+{%- endif %}
diff --git a/docs/conf.py b/docs/conf.py
index 019f9cc..88ceb27 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -181,6 +181,9 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
+# Custom CSS files
+html_css_files = ["custom.css"]
+
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
diff --git a/docs/ht.rst b/docs/ht.rst
deleted file mode 100644
index 5b53665..0000000
--- a/docs/ht.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-.. toctree::
-
- ht.air_cooler
- ht.boiling_flow
- ht.boiling_nucleic
- ht.boiling_plate
- ht.condensation
- ht.conduction
- ht.conv_external
- ht.conv_free_immersed
- ht.conv_free_enclosed
- ht.conv_internal
- ht.conv_jacket
- ht.conv_packed_bed
- ht.conv_plate
- ht.conv_supercritical
- ht.conv_tube_bank
- ht.conv_two_phase
- ht.core
- ht.hx
- ht.insulation
- ht.numba
- ht.radiation
- ht.vectorized
-
diff --git a/docs/index.rst b/docs/index.rst
index 949fd20..7452ce4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -44,11 +44,40 @@ Among the tasks this library can be used for are:
:alt: Zendo
:target: https://zenodo.org/badge/latestdoi/48963057
-Contents:
+Module Contents:
.. toctree::
+ :maxdepth: 1
+ :caption: Tutorial
+
tutorial
- modules
+
+.. toctree::
+ :maxdepth: 1
+ :caption: API
+
+ ht.air_cooler
+ ht.boiling_flow
+ ht.boiling_nucleic
+ ht.boiling_plate
+ ht.condensation
+ ht.conduction
+ ht.conv_external
+ ht.conv_free_immersed
+ ht.conv_free_enclosed
+ ht.conv_internal
+ ht.conv_jacket
+ ht.conv_packed_bed
+ ht.conv_plate
+ ht.conv_supercritical
+ ht.conv_tube_bank
+ ht.conv_two_phase
+ ht.core
+ ht.hx
+ ht.insulation
+ ht.numba
+ ht.radiation
+ ht.vectorized
Installation
diff --git a/docs/modules.rst b/docs/modules.rst
deleted file mode 100644
index 3fb52ba..0000000
--- a/docs/modules.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-API Reference
-=============
-
-.. toctree::
- :maxdepth: 4
-
- ht
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
index 4422134..796d294 100644
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@@ -12,7 +12,7 @@ heat transfer coefficient, the Nusselt number. The 'dimensional' heat transfer c
.. math::
h = \frac{k\cdot \text{Nu}}{L}
-Design philosophy
+Design Philosophy
-----------------
Like all libraries, this was developed to scratch my own itches. Since its
public release it has been found useful by many others, from students across
@@ -136,7 +136,7 @@ of the object and the wavelength to be considered.
>>> blackbody_spectral_radiance(T=800., wavelength=4E-6)
1311694129.7430933
-Heat exchanger sizing
+Heat Exchanger Sizing
---------------------
There are three popular methods of sizing heat exchangers. The log-mean temperature
@@ -150,7 +150,7 @@ supports the most types of heat exchangers; its form always requires the UA
term to be guessed however.
-LMTD correction factor method
+LMTD Correction Factor Method
-----------------------------
The simplest method, the log-mean temperature difference correction factor method,
@@ -193,7 +193,7 @@ provided.
39.75251118049003
-Effectiveness-NTU method
+Effectiveness-NTU Method
------------------------
This method uses the formula :math:`Q=\epsilon C_{min}(T_{h,i}-T_{c,i})`. The main
complication of this method is calculating effectiveness `epsilon`, which