update API doc

doc/source/conf.py

@@ -14,19 +14,20 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../..'))
+
+sys.path.insert(0, os.path.abspath("../.."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'pyModeS'
-copyright = '2019, Junzi Sun'
-author = 'Junzi Sun'
+project = "pyModeS"
+copyright = "2019, Junzi Sun"
+author = "Junzi Sun"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = ''
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -39,13 +40,13 @@ release = ''
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.napoleon',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -55,10 +56,10 @@ extensions = [
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -82,6 +83,10 @@ pygments_style = None
 # a list of builtin themes.
 #
 # html_theme = 'alabaster'
+html_theme = "neo_rtd_theme"
+import sphinx_theme
+
+html_theme_path = [sphinx_theme.get_html_theme_path()]
 
 # 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
@@ -108,7 +113,7 @@ pygments_style = None
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pyModeSdoc'
+htmlhelp_basename = "pyModeSdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -117,15 +122,12 @@ 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',
@@ -135,8 +137,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pyModeS.tex', 'pyModeS Documentation',
-     'Junzi Sun', 'manual'),
+    (master_doc, "pyModeS.tex", "pyModeS Documentation", "Junzi Sun", "manual")
 ]
 
 
@@ -144,10 +145,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pymodes', 'pyModeS Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "pymodes", "pyModeS Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -156,9 +154,15 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'pyModeS', 'pyModeS Documentation',
-     author, 'pyModeS', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "pyModeS",
+        "pyModeS Documentation",
+        author,
+        "pyModeS",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 
@@ -177,7 +181,7 @@ epub_title = project
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------