Skip to content

Commit

Permalink
preparing online docs
Browse files Browse the repository at this point in the history
  • Loading branch information
weikang9009 committed Sep 26, 2018
1 parent 934b7c8 commit a923b90
Show file tree
Hide file tree
Showing 47 changed files with 876 additions and 10 deletions.
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
__pycache__
*.swp
*.pyc
.rope*
.idea/
notebooks/.ipynb_checkpoints/
.DS_Store
.ipynb_checkpoints/
*.bak
.eggs/
*.egg-info/

# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64
24 changes: 24 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = mgwr
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
rm -rf $(BUILDDIR)/*
rm -rf auto_examples/
Binary file added doc/_static/images/pysal_favicon.ico
Binary file not shown.
73 changes: 73 additions & 0 deletions doc/_static/pysal-styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/* Make thumbnails with equal heights */
@media only screen and (min-width : 481px) {
.row.equal-height {
display: flex;
flex-wrap: wrap;
}
.row.equal-height > [class*='col-'] {
display: flex;
flex-direction: column;
}
.row.equal-height.row:after,
.row.equal-height.row:before {
display: flex;
}

.row.equal-height > [class*='col-'] > .thumbnail,
.row.equal-height > [class*='col-'] > .thumbnail > .caption {
display: flex;
flex: 1 0 auto;
flex-direction: column;
}
.row.equal-height > [class*='col-'] > .thumbnail > .caption > .flex-text {
flex-grow: 1;
}
.row.equal-height > [class*='col-'] > .thumbnail > img {
width: 100%;
height: 200px; /* force image's height */

/* force image fit inside it's "box" */
-webkit-object-fit: cover;
-moz-object-fit: cover;
-ms-object-fit: cover;
-o-object-fit: cover;
object-fit: cover;
}
}

.row.extra-bottom-padding{
margin-bottom: 20px;
}


.topnavicons {
margin-left: 10% !important;
}

.topnavicons li {
margin-left: 0px !important;
min-width: 100px;
text-align: center;
}

.topnavicons .thumbnail {
margin-right: 10px;
border: none;
box-shadow: none;
text-align: center;
font-size: 85%;
font-weight: bold;
line-height: 10px;
height: 100px;
}

.topnavicons .thumbnail img {
display: block;
margin-left: auto;
margin-right: auto;
}


/* Table with a scrollbar */
.bodycontainer { max-height: 600px; width: 100%; margin: 0; overflow-y: auto; }
.table-scrollable { margin: 0; padding: 0; }
20 changes: 20 additions & 0 deletions doc/_static/references.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
%% This BibTeX bibliography file was created using BibDesk.
%% http://bibdesk.sourceforge.net/
%% Created for Wei Kang at 2018-08-05 16:12:26 -0700
%% Saved with string encoding Unicode (UTF-8)
@book{Press2007,
Address = {Cambridge},
Author = {Press, William H and Teukolsky, Saul A and Vetterling, William T and Flannery, Brian P},
Date-Added = {2018-06-12 22:53:57 +0000},
Date-Modified = {2018-06-12 22:54:05 +0000},
Edition = {3rd},
Keywords = {rank.py},
Publisher = {Cambridge Univ Pr},
Title = {Numerical recipes: the art of scientific computing},
Year = {2007}}
41 changes: 41 additions & 0 deletions doc/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. _api_ref:

.. currentmodule:: mgwr

API reference
=============

.. _gwr_api:

GWR Model Estimation and Inference
----------------------------------

.. autosummary::
:toctree: generated/

mgwr.gwr.GWR
mgwr.gwr.GWRResults
mgwr.gwr.GWRResultsLite


MGWR Estimation and Inference
-----------------------------

.. autosummary::
:toctree: generated/

mgwr.gwr.MGWR
mgwr.gwr.MGWRResults


Utility Functions
-----------------

Kernal Specifications
~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated/

mgwr.kernel.fix_gauss
mgwr.kernel.
Loading

0 comments on commit a923b90

Please sign in to comment.