pysal · xyluo25 · Feb 1, 2024 · Feb 1, 2024 · Feb 1, 2024 · Feb 1, 2024
diff --git a/.gitignore b/.gitignore
@@ -24,4 +24,6 @@ develop-eggs
 .installed.cfg
 lib
 lib64
-_build
+_build
+*sources*
+.pytest_cache
diff --git a/doc/_static/references.bib b/doc/_static/references.bib
@@ -1,11 +1,9 @@
 %% This BibTeX bibliography file was created using BibDesk.
 %% https://bibdesk.sourceforge.io/
 
-%% Created for weikang at 2019-06-29 12:42:56 -0700 
-
-
-%% Saved with string encoding Unicode (UTF-8) 
+%% Created for weikang at 2019-06-29 12:42:56 -0700
 
+%% Saved with string encoding Unicode (UTF-8)
 
 
 @article{yu:2019,

diff --git a/doc/conf.py b/doc/conf.py
@@ -14,13 +14,20 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import sys, os
+import sys
+import os
 import sphinx_bootstrap_theme
 
-sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../'))
 
-#import your package to obtain the version info to display on the docs website
-import mgwr
+# import your package to obtain the version info to display on the docs website
+try:
+    # import your package
+    import mgwr
+except ImportError:
+    # if your package is not installed, import it from the source directory
+    # sys.path.insert(0, os.path.abspath('../mgwr'))
+    import mgwr
 
 # -- General configuration ------------------------------------------------
 
@@ -30,12 +37,20 @@
 # 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_gallery.gen_gallery',
+# Enable google docstring style and numpy docstring style with napoleon
+extensions = [  # 'sphinx_gallery.gen_gallery',
     'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode',
     'sphinxcontrib.bibtex', 'sphinx.ext.mathjax', 'sphinx.ext.doctest',
     'sphinx.ext.intersphinx', 'numpydoc', 'matplotlib.sphinxext.plot_directive'
 ]
 
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+
+# for sphinxcontrib-bibtex
+bibtex_bibfiles = ['_static/references.bib']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -54,19 +69,19 @@
 author = 'pysal developers'
 
 # The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
+# version and release, also used in various other places throughout the
 # built documents.
 #
 # The full version.
-version = mgwr.__version__  #should replace it with your PACKAGE_NAME
-release = mgwr.__version__  #should replace it with your PACKAGE_NAME
+version = mgwr.__version__  # should replace it with your PACKAGE_NAME
+release = mgwr.__version__  # should replace it with your PACKAGE_NAME
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -91,7 +106,7 @@
 
 # (Optional) Logo of your package. Should be small enough to fit the navbar (ideally 24x24).
 # Path should be relative to the ``_static`` files directory.
-#html_logo = "_static/images/package_logo.jpg"
+# html_logo = "_static/images/package_logo.jpg"
 
 # (Optional) PySAL favicon
 html_favicon = "_static/images/pysal_favicon.ico"
@@ -111,20 +126,19 @@
     False,
 
     # Render the current pages TOC in the navbar. (Default: true)
-    #'navbar_pagenav': True,
-    #'navbar_pagenav': False,
+    'navbar_pagenav': False,
+    # 'navbar_pagenav': False,
 
     # No sidebar
     'nosidebar':
     True,
 
     # Tab name for the current pages TOC. (Default: "Page")
-    #'navbar_pagenav_name': "Page",
+    # 'navbar_pagenav_name': "Page",
 
     # Global TOC depth for "site" navbar tab. (Default: 1)
     # Switching to -1 shows all levels.
-    'globaltoc_depth':
-    2,
+    'globaltoc_depth': 1,
 
     # Include hidden TOCs in Site navbar?
     #
@@ -133,17 +147,15 @@
     # will break.
     #
     # Values: "true" (default) or "false"
-    'globaltoc_includehidden':
-    "true",
+    'globaltoc_includehidden': "false",
 
     # HTML navbar class (Default: "navbar") to attach to <div> element.
     # For black navbar, do "navbar navbar-inverse"
-    #'navbar_class': "navbar navbar-inverse",
+    # 'navbar_class': "navbar navbar-inverse",
 
     # Fix navigation bar to top of page?
     # Values: "true" (default) or "false"
-    'navbar_fixed_top':
-    "true",
+    'navbar_fixed_top': "true",
 
     # Location of link to source.
     # Options are "nav" (default), "footer" or anything else to exclude.
@@ -176,7 +188,7 @@
 html_static_path = ['_static']
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 # html_sidebars = {'sidebar': ['localtoc.html', 'sourcelink.html', 'searchbox.html']}
 
 # -- Options for HTMLHelp output ------------------------------------------
@@ -234,18 +246,20 @@
 
 # Generate the API documentation when building
 autosummary_generate = True
-numpydoc_show_class_members = True
+numpydoc_show_class_members = False
 class_members_toctree = True
 numpydoc_show_inherited_class_members = True
 numpydoc_use_plots = True
 
 # display the source code for Plot directive
 plot_include_source = True
 
+# def setup(app):
+#     app.add_css_stylesheet("pysal-styles.css")
 
-def setup(app):
-    app.add_stylesheet("pysal-styles.css")
+# add style file to html output
+html_css_files = ['pysal-styles.css', "_static/pysal-styles.css"]
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/3.6/': None}
+# intersphinx_mapping = {'https://docs.python.org/3.10/': None}
diff --git a/doc/generated/mgwr.gwr.GWR.fit.rst b/doc/generated/mgwr.gwr.GWR.fit.rst
diff --git a/doc/generated/mgwr.gwr.GWR.predict.rst b/doc/generated/mgwr.gwr.GWR.predict.rst
diff --git a/doc/generated/mgwr.gwr.GWR.rst b/doc/generated/mgwr.gwr.GWR.rst
@@ -1,4 +1,4 @@
-mgwr.gwr.GWR
+mgwr.gwr.GWR
 ============
 
 .. currentmodule:: mgwr.gwr
@@ -8,5 +8,26 @@ mgwr.gwr.GWR
 
    .. automethod:: __init__
 
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~GWR.__init__
+      ~GWR.df_model
+      ~GWR.df_resid
+      ~GWR.fit
+      ~GWR.predict
+
+
 
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~GWR.mean_y
+      ~GWR.std_y
+
 
diff --git a/doc/generated/mgwr.gwr.GWRResults.rst b/doc/generated/mgwr.gwr.GWRResults.rst
@@ -1,4 +1,4 @@
-mgwr.gwr.GWRResults
+mgwr.gwr.GWRResults
 ===================
 
 .. currentmodule:: mgwr.gwr
@@ -8,7 +8,64 @@ mgwr.gwr.GWRResults
 
    .. automethod:: __init__
 
+
+   .. rubric:: Methods
 
+   .. autosummary::
+
+      ~GWRResults.D2
+      ~GWRResults.ENP
+      ~GWRResults.R2
+      ~GWRResults.RSS
+      ~GWRResults.TSS
+      ~GWRResults.W
+      ~GWRResults.__init__
+      ~GWRResults.adj_D2
+      ~GWRResults.adj_R2
+      ~GWRResults.adj_alpha
+      ~GWRResults.adj_pseudoR2
+      ~GWRResults.aic
+      ~GWRResults.aicc
+      ~GWRResults.bic
+      ~GWRResults.bse
+      ~GWRResults.conf_int
+      ~GWRResults.cooksD
+      ~GWRResults.cov_params
+      ~GWRResults.critical_tval
+      ~GWRResults.deviance
+      ~GWRResults.df_model
+      ~GWRResults.df_resid
+      ~GWRResults.filter_tvals
+      ~GWRResults.get_bws_intervals
+      ~GWRResults.global_deviance
+      ~GWRResults.initialize
+      ~GWRResults.llf
+      ~GWRResults.llnull
+      ~GWRResults.localR2
+      ~GWRResults.local_collinearity
+      ~GWRResults.normalized_cov_params
+      ~GWRResults.null
+      ~GWRResults.null_deviance
+      ~GWRResults.pDev
+      ~GWRResults.pearson_chi2
+      ~GWRResults.predictions
+      ~GWRResults.pseudoR2
+      ~GWRResults.pvalues
+      ~GWRResults.resid_anscombe
+      ~GWRResults.resid_deviance
+      ~GWRResults.resid_pearson
+      ~GWRResults.resid_response
+      ~GWRResults.resid_ss
+      ~GWRResults.resid_working
+      ~GWRResults.scale
+      ~GWRResults.sigma2
+      ~GWRResults.spatial_variability
+      ~GWRResults.std_res
+      ~GWRResults.summary
+      ~GWRResults.tr_S
+      ~GWRResults.tvalues
+      ~GWRResults.use_t
+      ~GWRResults.y_bar
 
 
 

diff --git a/doc/generated/mgwr.gwr.GWRResultsLite.rst b/doc/generated/mgwr.gwr.GWRResultsLite.rst
@@ -1,4 +1,4 @@
-mgwr.gwr.GWRResultsLite
+mgwr.gwr.GWRResultsLite
 =======================
 
 .. currentmodule:: mgwr.gwr
@@ -9,6 +9,18 @@ mgwr.gwr.GWRResultsLite
    .. automethod:: __init__
 
 
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~GWRResultsLite.__init__
+      ~GWRResultsLite.llf
+      ~GWRResultsLite.mu
+      ~GWRResultsLite.predy
+      ~GWRResultsLite.resid_ss
+      ~GWRResultsLite.tr_S
+
+
 
 
 

diff --git a/doc/generated/mgwr.gwr.GWResults.ENP.rst b/doc/generated/mgwr.gwr.GWResults.ENP.rst
diff --git a/doc/generated/mgwr.gwr.GWResults.RSS.rst b/doc/generated/mgwr.gwr.GWResults.RSS.rst
diff --git a/doc/generated/mgwr.gwr.GWResults.TSS.rst b/doc/generated/mgwr.gwr.GWResults.TSS.rst
diff --git a/doc/generated/mgwr.gwr.GWResults.adj_alpha.rst b/doc/generated/mgwr.gwr.GWResults.adj_alpha.rst
diff --git a/doc/generated/mgwr.gwr.GWResults.bse.rst b/doc/generated/mgwr.gwr.GWResults.bse.rst