Update docs rendering (#89)

* .

* .

* .

* Restrict

* .

* v1.2.8

* Another shoul dnot release

* .

* 1.2.9 test

* 1.2.10 test

* bump

* Very painful process

* 1.3.0 attemped direct release to pypi

* Test improvement

* Docs update

Author: CalebBell

.gitignore

@@ -61,6 +61,8 @@ dev/pyinstaller/build
 ._*
 _*
 !_custom_build/
+!docs/_templates/
+!docs/_static/
 .Spotlight-V100
 .Trashes
 ehthumbs.db

docs/Samples/Tank.ipynb

@@ -4,11 +4,7 @@
    "cell_type": "markdown",
    "id": "83344e81",
    "metadata": {},
-   "source": [
-    "## Sample Program:\n",
-    "\n",
-    "Function to automatically create a representative horizontal vessel in the process industry given a volume."
-   ]
+   "source": "## Tank Design and Weight Estimation\n\nSample program demonstrating how to automatically create a representative horizontal vessel in the process industry given a volume."
   },
   {
    "cell_type": "code",
@@ -689,4 +685,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}

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;
+}

docs/_templates/localtoc.html

@@ -0,0 +1,7 @@
+{# Custom local TOC template with depth limit #}
+{%- if display_toc %}
+  <div>
+    <h3><a href="{{ pathto(root_doc)|e }}">{{ _('Table of Contents') }}</a></h3>
+    {{ toctree(maxdepth=1, collapse=False, includehidden=True) }}
+  </div>
+{%- endif %}

docs/conf.py

@@ -163,6 +163,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.

docs/developers.rst

@@ -89,7 +89,7 @@ Type hints are a work in progress. After numerous years supporting old python ve
 
 Supported Python Versions
 -------------------------
-Fluids targets Python 3.9 and up as well as PyPy3. Additionally, fluids has been tested by the author at various points to load in Micropython.
+Fluids targets Python 3.9 and up as well as PyPy3. Additionally, Fluids has been tested by the author at various points to load in Micropython.
 
 Unfortunately there is no CI infrastructure for these other Python implementations. 
 For Micropython there is no NumPy/SciPy which means there is no hope of passing the whole test suite on them either; indeed pytest won't load on any of them.
@@ -100,7 +100,7 @@ Over the years the development speed of Python and IronPython have diverged sign
 Although a Python 3 IronPython was released at the end of 2022, the Python version implemented (3.4) was already dropped from support by Fluids; the CI could no longer work with it.
 At this point it would probably be recommended to use an old version of fluids with IronPython and the library will probably fail to load in IronPython due to the use of modern syntax.
 
-Micropython is designed to run on limited RAM, and fluids is too large for most microprocessors. 
+Micropython is designed to run on limited RAM, and Fluids is too large for most microprocessors. 
 You will likely have to copy/paste the specific parts of `fluids` you want to use on a microprocessor.
 
 Packaging

docs/examples.rst

@@ -1,9 +1,9 @@
 Solved Fluids Mechanics Problems
 ================================
 
-A collection of problems from Crane TP 410 have been solved using the fluids library.
+A collection of problems from Crane TP 410 have been solved using the Fluids library.
 These are industrially relevant problems. Crane TP 410 is used extensively as a source in
-fluids, although often there are better correlations that are implemented and chosen as default methods.
+Fluids, although often there are better correlations that are implemented and chosen as default methods.
 All problems include a description of the problems, but Crane TP 410 includes schematics that are
 not included here. A copy can be obtained from your local library or bought `here <https://store.flowoffluids.com/Book-CraneTP410.html>`_.
 

docs/fluids.rst

@@ -17,10 +17,46 @@ other flow meters, ejectors, relief valves, and more.
 Module Contents:
 
 .. toctree::
-   :maxdepth: 2
-   
+   :maxdepth: 1
+   :caption: Tutorial
+
    tutorial.rst
-   modules.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: API
+
+   fluids.atmosphere
+   fluids.compressible
+   fluids.control_valve
+   fluids.core
+   fluids.drag
+   fluids.filters
+   fluids.fittings
+   fluids.flow_meter
+   fluids.friction
+   fluids.geometry
+   fluids.jet_pump
+   fluids.mixing
+   fluids.numba
+   fluids.open_flow
+   fluids.packed_bed
+   fluids.packed_tower
+   fluids.particle_size_distribution
+   fluids.piping
+   fluids.pump
+   fluids.safety_valve
+   fluids.separator
+   fluids.saltation
+   fluids.two_phase
+   fluids.two_phase_voidage
+   fluids.units
+   fluids.vectorized
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Additional Resources
+
    examples.rst
    data.rst
    sample_programs.rst
@@ -68,15 +104,15 @@ To get the git version, run:
 Latest source code
 ------------------
 
-The latest development version of fluids's sources can be obtained at
+The latest development version of Fluids's sources can be obtained at
 
     https://github.com/CalebBell/fluids
 
 
 Bug reports
 -----------
 
-To report bugs, please use the fluids's Bug Tracker at:
+To report bugs, please use the Fluids's Bug Tracker at:
 
     https://github.com/CalebBell/fluids/issues