DOC: get docs to build

tacaswell · tacaswell · commit bf9d6cb0ca09 · 2022-11-06T13:20:28.000-05:00
There are still rst warnings that are not addressed
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 trendvis/version.py
 result_images
 *~
+doc/build
+doc/source/generated
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -36,7 +36,6 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
-    'matplotlib.sphinxext.only_directives',
     'matplotlib.sphinxext.plot_directive',
     'IPython.sphinxext.ipython_directive',
     'IPython.sphinxext.ipython_console_highlighting',
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,16 +1,11 @@
 .. currentmodule:: trendvis
 
-====================
+==========
  TrendVis
-====================
-
-.. htmlonly::
-
-    :Release: |version|
-    :Date: |today|
+==========
 
 :py:mod:`trendvis` API
-====================
+======================
 
 .. autosummary::
    :toctree: generated/
@@ -87,9 +82,9 @@ Creating a `YGrid` is essentially the same as an `XGrid`.
    nums = 10
    lw = 1.5
 
-   ex0 = YGrid([1,2,1], figsize=(5,5))
+   ex0 = trendvis.YGrid([1,2,1], figsize=(5,5))
 
-   plot_data(ex0, [[(xvals, np.linspace(0, 9.5, num=nums), 'blue')],
+   trendvis.plot_data(ex0, [[(xvals, np.linspace(0, 9.5, num=nums), 'blue')],
                    [(xvals*5, np.linspace(1, 9, num=nums),  'red')],
                    [(xvals*10, np.linspace(0.5, 10, num=nums),'green')]],
              lw=1.5, auto_spinecolor=True, markeredgecolor='none', marker='s')
@@ -104,4 +99,3 @@ Creating a `YGrid` is essentially the same as an `XGrid`.
    ex0.axes[0][0].set_ylabel('Main Axis', fontsize=14)
 
    ex0.fig.subplots_adjust(wspace=-0.3)
-
