Overhauling docs. Cleaned up errors. Updated some paragraphs.

kbonney · Jul 27, 2023 · b63fe05 · b63fe05
1 parent ad61bc1
commit b63fe05
Show file tree

Hide file tree

Showing 19 changed files with 443 additions and 443 deletions.
diff --git a/docs/apidoc/pynumad.objects.rst b/docs/apidoc/pynumad.objects.rst
@@ -10,6 +10,7 @@ Submodules
 ----------
 
 .. toctree::
+    :maxdepth: 1
 
     pynumad.objects.Airfoil
     pynumad.objects.Blade

diff --git a/docs/apidoc/pynumad.utils.rst b/docs/apidoc/pynumad.utils.rst
@@ -11,11 +11,6 @@ pynumad.utils module
     :no-undoc-members:
     :show-inheritance:
 
-.. automodule:: pynumad.utils.mesh_utils
-    :members:
-    :no-undoc-members:
-    :show-inheritance:
-
 .. automodule:: pynumad.utils.misc_utils
     :members:
     :no-undoc-members:

diff --git a/docs/citation.rst b/docs/citation.rst
@@ -5,10 +5,10 @@ Citing NuMAD
 
 To cite NuMAD v3.0, please utilize the reference below.
 
+[1] Camarena, E., Anderson, E., Paquette, J., Bortolotti, P., Feil, R.,
+& Johnson, N. (2021). Land-based wind turbines with flexible rail
+transportable blades–Part II: 3D FEM design optimization of the rotor
+blades. Wind Energy Science Discussions, 1-28.
 
-[1] Camarena, E., Anderson, E., Paquette, J., Bortolotti, P., Feil, R., & Johnson, N. (2021). Land-based wind turbines with flexible rail transportable blades–Part II: 3D FEM design optimization of the rotor blades. Wind Energy Science Discussions, 1-28.   
-
-
-.. Kelley: replace with DOI citation once release is tagged
-
-
+..
+   Kelley: replace with DOI citation once release is tagged
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,19 +2,14 @@
 # http://www.sphinx-doc.org/en/master/config
 
 # -- Path setup --------------------------------------------------------------
-import os
-import sys
 
 # -- Project information -----------------------------------------------------
-
 project = 'PyNuMAD'
 copyright = '2023, Kirk Bonney'
 author = 'Kirk Bonney'
-
 version = '1.0'
 release = '1.0'
 
-
 # -- General configuration ---------------------------------------------------
 
 extensions = [
@@ -34,13 +29,9 @@
 autodoc_member_order = 'bysource'
 autoclass_content = 'both'
 bibtex_bibfiles = ['refs/publications.bib','refs/conclusion.bib']
-
 templates_path = ['_templates']
-
 source_suffix = '.rst'
-
 master_doc = 'index'
-
 language = "en"
 
 # List of patterns, relative to source directory, that match files and
@@ -55,7 +46,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
+
 html_theme = 'sphinx_rtd_theme'
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -67,66 +58,4 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PyNuMADdoc'
-
-
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'PyNuMAD.tex', 'PyNuMAD Documentation',
-     'Kirk Bonney', 'manual'),
-]
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pynumad', 'PyNuMAD Documentation',
-     [author], 1)
-]
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 'PyNuMAD', 'PyNuMAD Documentation',
-     author, 'PyNuMAD', 'One line description of project.',
-     'Miscellaneous'),
-]
-
-
-# -- Extension configuration -------------------------------------------------
-
-# -- Options for intersphinx extension ---------------------------------------
-
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
-
-# -- Options for todo extension ----------------------------------------------
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+htmlhelp_basename = 'PyNuMADdoc'