Updated documentation

docs/code_of_conduct.rst

@@ -0,0 +1,4 @@
+Code of Conduct
+===============
+.. include:: ../CODE_OF_CONDUCT.md
+    :parser: myst_parser.sphinx_

docs/conf.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# shasta documentation build configuration file, created by
+# SHaSTA documentation build configuration file, created by
 # sphinx-quickstart on Fri Jun  9 13:47:02 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -20,9 +20,8 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
-import shasta  # noqa
 
 # -- General configuration ---------------------------------------------
 
@@ -33,33 +32,34 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.autodoc',
-    'autoapi.extension',
-    'sphinx.ext.inheritance_diagram',
-    'sphinx.ext.githubpages',
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autodoc",
+    "autoapi.extension",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.githubpages",
     "sphinx.ext.graphviz",
+    "myst_parser",
 ]
 
 # AutoAPI setting
-autoapi_type = 'python'
-autoapi_dirs = ['../shasta']
+autoapi_type = "python"
+autoapi_dirs = ["../shasta"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = [".rst", ".md"]
+# source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'shasta'
+project = "SHaSTA"
 copyright = "2020, Hemanth Manjunatha"
 author = "Hemanth Manjunatha"
 
@@ -68,9 +68,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = '0.1.0'
+version = "0.1.0"
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = "0.1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -81,7 +81,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
@@ -102,7 +102,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"
+html_theme = "furo"
 
 # 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
@@ -114,12 +114,12 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # html_static_path = ['_static']
-html_style = 'css/custom.css'
+# html_style = 'css/custom.css'
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'shastadoc'
+htmlhelp_basename = "SHaSTAdoc"
 
 # -- Options for LaTeX output ------------------------------------------
 
@@ -142,14 +142,14 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'shasta.tex', 'shasta Documentation', 'Hemanth Manjunatha', 'manual'),
+    (master_doc, "SHaSTA.tex", "SHaSTA Documentation", "Hemanth Manjunatha", "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, 'shasta', 'shasta Documentation', [author], 1)]
+man_pages = [(master_doc, "SHaSTA", "SHaSTA Documentation", [author], 1)]
 
 # -- Options for Texinfo output ----------------------------------------
 
@@ -159,12 +159,12 @@
 texinfo_documents = [
     (
         master_doc,
-        'shasta',
-        'shasta Documentation',
+        "SHaSTA",
+        "SHaSTA Documentation",
         author,
-        'shasta',
-        'One line description of project.',
-        'Miscellaneous',
+        "SHaSTA",
+        "One line description of project.",
+        "Miscellaneous",
     ),
 ]
 

docs/contributing.rst

@@ -1 +1,4 @@
-.. include:: ../CONTRIBUTING.rst
+Contributing
+===========
+.. include:: ../CONTRIBUTING.md
+    :parser: myst_parser.sphinx_

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0f3f600e895ccc60e1d591663fb015d5
+config: 9679b8f1632111510dea9e63e8ea6a5a
 tags: 645f666f9bcd5a90fca523b33c5a78b7