From 4aefccc7fb512a4d32306ed5654424890c95b321 Mon Sep 17 00:00:00 2001 From: Tom Caruso Date: Wed, 5 Aug 2020 02:35:20 -0400 Subject: [PATCH] update documentation --- docs/conf.py | 9 ++++++--- docs/manual.rst | 17 ++++++----------- docs/modules.rst | 27 +++++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 14 deletions(-) create mode 100644 docs/modules.rst diff --git a/docs/conf.py b/docs/conf.py index e358370..532a4e4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,9 +10,9 @@ # 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 os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.abspath('..')) # -- Project information ----------------------------------------------------- @@ -28,6 +28,9 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + # 'matplotlib.sphinxext.plot_directive', + 'sphinx.ext.autodoc', + # 'sphinx.ext.mathjax', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/manual.rst b/docs/manual.rst index 59dbea5..2d03a5b 100644 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -5,8 +5,6 @@ Meridian User Manual ======================= -.. _intro: - Introduction ============ @@ -54,9 +52,9 @@ once data exploration is concluded. Core Models ============ -Meridian implements two main data types which users will leverage: the `Record` and the `Dataset`. Naturally, a `Record` -represents an individual row or record in your dataset, while a `Dataset` is a collection of `Record`s with a spatial -index for efficient queries. +Meridian implements two main data types which users will leverage: the `Record` and the `Dataset`. Naturally, +a `Record` represents an individual row or record in your dataset, while a `Dataset` is a collection of `Record` +with a spatial index for efficient queries. Record ^^^^^^^ @@ -128,10 +126,7 @@ to our data: return self.total_mw / self.install_mw * 100 - - - -.. _design +.. _design: Design Goals ============= @@ -147,10 +142,10 @@ Meridian's `Record` models draw strong inspiration from `pydantic`'s `BaseModel` part of that wheel for the purpose of efficiency and narrowing of focus. -.. _benchmarks +.. _benchmarks: Benchmarks =========== A dataset opened with Meridian can use up to half as much memory as the same dataset in GeoPandas, -depending on the characteristics of the geometry. \ No newline at end of file +depending on the characteristics of the geometry. Oh yeah? Prove it! \ No newline at end of file diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..7e89f6a --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,27 @@ +.. modules: + +======================= +API Documentation +======================= + + +Dataset +======================= + +.. automodule:: meridian.dataset + :members: + :show-inheritance: + +Record +======================= + +.. automodule:: meridian.record + :members: + :show-inheritance: + +Product +======================= + +.. automodule:: meridian.product + :members: + :show-inheritance: