Small docs update

docs/conf.py

@@ -48,15 +48,33 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
+    #'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
-    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosummary',
     'numpydoc',
+    'IPython.sphinxext.ipython_console_highlighting',
+    'IPython.sphinxext.ipython_directive',
+    'sphinx.ext.intersphinx',
     'nbsphinx',
     'matplotlib.sphinxext.plot_directive',
+    'sphinxcontrib.katex',
     'sphinx_sitemap',
 ]
-#    'sphinxcontrib.katex',
+#    
+
+katex_css_path = \
+    'https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css'
+katex_js_path = \
+    'https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.js'
+katex_autorender_path = \
+    'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.12.0/contrib/auto-render.min.js'
+
+
+html_baseurl = 'https://ht.readthedocs.io/'
+sitemap_url_scheme = "{link}"
+sitemap_filename = 'sitemap2.xml' # readthedocs generates its own
+
+
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -74,7 +92,7 @@
 project = u'Heat Transfer'
 
 import datetime
-copyright = u'2016 - %s, Caleb Bell <Caleb.Andrew.Bell@gmail.com>' %datetime.datetime.now().year
+copyright = u'2016 - %s, Caleb Bell and contributors' %datetime.datetime.now().year
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -98,7 +116,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '**.ipynb_checkpoints']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -129,7 +147,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'nature'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -275,6 +293,9 @@
    u'Caleb Bell', 'Heat Transfer', 'One line description of project.',
    'Miscellaneous'),
 ]
+nbsphinx_requirejs_path = '' # fixes katex not working
+plot_rcparams = {'savefig.bbox': 'tight'}
+plot_apply_rcparams = True  # if context option is used
 
 # Documents to append as an appendix to all manuals.
 #texinfo_appendices = []
@@ -288,10 +309,20 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
+                       'numpy': ('http://docs.scipy.org/doc/numpy', None),
+                       'scipy': ('http://docs.scipy.org/doc/scipy/reference', None),
+                       'matplotlib': ('http://matplotlib.sourceforge.net', None),
+                       'thermo': ('https://thermo.readthedocs.io/', None),           		               'chemicals': ('https://chemicals.readthedocs.io/', None),
+                       'fluids': ('https://fluids.readthedocs.io/', None)}
 html_theme = "nature"
 
 from sphinx.ext.autodoc import between
 
+try:
+    import ht.numba
+except:
+    pass
 def setup(app):
     # Register a sphinx.ext.autodoc.between listener to ignore everything
     # between lines that contain the word IGNORE

docs/index.rst

@@ -1,8 +1,12 @@
-Heat transfer component of Chemical Engineering Design Library (ChEDL) ======================================================================
+ht: Heat Transfer component of Chemical Engineering Design Library (ChEDL)
+==========================================================================
 
   .. meta::
       :google-site-verification: wcmDZ88ikLzq1to6urRDGA6R7oIhzya2sN5hOeV1zZw
 
+Introduction
+------------
+
 ht is open-source software for engineers and technicians working in the
 fields of chemical or mechanical engineering. It includes modules
 for various heat transfer functions.
@@ -97,7 +101,7 @@ Citation
 
 To cite ht in publications use::
 
-    Caleb Bell (2016-2021). ht: Heat transfer component of Chemical Engineering Design Library (ChEDL)
+    Caleb Bell and Contributors (2016-2021). ht: Heat transfer component of Chemical Engineering Design Library (ChEDL)
     https://github.com/CalebBell/ht.