adding automodule and autosummary

choldgraf · choldgraf · commit 09a70c1d975a · 2019-11-05T22:07:24.000-08:00
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -8,210 +8,4 @@ master
 New Features
 -------------
 
-Fixes
------
-
-* Fix definition lists looking different with Sphinx 2.0+
-
-Other Changes
---------------
-
-* Add the ``navigation`` template block around the navigation area.
-* Added Spanish translation
-* Added i18n support using Babel
-* Moved build system from Grunt and friends to Webpack
-
-0.4.3
-======
-
-:Date: Feb 12, 2019
-
-New Features
--------------
-
-Fixes
------
-
-* Fix scrolling to active item in sidebar on load (#214)
-* Style caption link for code and literal blocks
-* Fix inconsistent font size and line height for autodoc "raises" and "returns" (#267)
-* Fix last_updated notice appearing in same line as copyright notice (#704)
-
-
-Other Changes
---------------
-
-v0.4.2
-======
-
-:Date: Oct 5, 2018
-
-New Features
--------------
-
-Fixes
------
-
-* Set base font size on <html> (#668)
-* Fix HTML search not working with Sphinx-1.8 (#672)
-
-Other Changes
---------------
-
-* Upload signed packages to PyPI with twine (#651)
-* Do not enforce period at the end of copyright statement (666)
-
-v0.4.1
-======
-
-:Date: July 27, 2018
-
-New Features
--------------
-
-Fixes
------
-
-* Line height adjustments for Liberation Mono (#656)
-
-Other Changes
---------------
-
-* Add Sphinx as a dependency
-
-v0.4.0
-======
-
-This version made some changes to how JS and CSS were included
-when the theme is used on Read the Docs.
-
-
-New Features
--------------
-
-Fixes
------
-
-* Do not rely on readthedocs.org for CSS/JS (#614)
-* Color accessibility improvements on the left navigation
-
-Other Changes
----------------
-
-* Write theme version and build date at top of JavaScript and CSS
-* Changed code and literals to use a native font stack (#612)
-* Fix small styling issues
-
-v0.3.1
-======
-
-Fixes
------
-
-* Revert part of #576 causing display issues with version selector menu
-* Backwards compatibility fixes for pre-0.3.0 releases (#623)
-* Fix mkdocs version selector (#622)
-* Add open list spacing (#591)
-* Fix table centering (#599)
-
-v0.3.0
-======
-
-**Note**: this version resulted in some JavaScript incompatibilities when used on readthedocs.org
-
-New Features
--------------
-
-* Add html language attribute
-* Allow setting 'rel' and 'title' attributes for stylesheets (#551)
-* Add option to style external links
-* Add github, gitlab, bitbucket page arguments option
-* Add pygments support
-* Add setuptools entry point allowing to use ``sphinx_rtd_theme`` as
-  Sphinx ``html_theme`` directly.
-* Add language to the JS output variable
-
-Fixes
------
-
-* Fix some HTML warnings and errors
-* Fix many styling issues
-* Fix many sidebar glitches
-* Fix line number spacing to align with the code lines
-* Hide Edit links on auto created pages
-* Include missing font files with the theme
-
-Other Changes
---------------
-
-* Significant improvement of our documentation
-* Compress our Javascript files
-* Updated dependencies
-
-v0.2.4
-======
-
-* Yet another patch to deal with extra builders outside Spinx, such as the
-  singlehtml builders from the Read the Docs Sphinx extension
-
-v0.2.3
-======
-
-* Temporarily patch Sphinx issue with ``singlehtml`` builder by inspecting the
-  builder in template.
-
-v0.2.2
-======
-
-* Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and
-  introduced another bug with toctrees display.
-
-v0.2.1
-======
-
-* Add the ``rel`` HTML attribute to the footer links which point to
-  the previous and next pages.
-* Fix toctree issue caused by Sphinx singlehtml builder (#367)
-
-v0.2.0
-======
-
-* Adds the ``comments`` block after the ``body`` block in the template
-* Added "Edit on GitLab" support
-* Many bug fixes
-
-v0.1.10-alpha
-=============
-
-.. note:: This is a pre-release version
-
-* Removes Sphinx dependency
-* Fixes hamburger on mobile display
-* Adds a ``body_begin`` block to the template
-* Added ``prev_next_buttons_location``
-
-v0.1.9
-======
-
-* Intermittent scrollbar visibility bug fixed. This change introduces a
-  backwards incompatible change to the theme's layout HTML. This should only be
-  a problem for derivative themes that have overridden styling of nav elements
-  using direct descendant selectors. See `#215`_ for more information.
-* Safari overscroll bug fixed
-* Version added to the nav header
-* Revision id was added to the documentation footer if you are using RTD
-* An extra block, ``extrafooter`` was added to allow extra content in the
-  document footer block
-* Fixed modernizr URL
-* Small display style changes on code blocks, figure captions, and nav elements
-
-.. _#215: https://github.com/rtfd/sphinx_rtd_theme/pull/215
-
-v0.1.8
-======
-
-* Start keeping changelog :)
-* Support for third and fourth level headers in the sidebar
-* Add support for Sphinx 1.3
-* Add sidebar headers for :caption: in Sphinx toctree
-* Clean up sidebar scrolling behavior so it never scrolls out of view
+* The theme now exists...
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,6 +32,8 @@
 # ones.
 
 extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/docs/demo/api.rst b/docs/demo/api.rst
@@ -2,15 +2,35 @@
 API documentation and generated content
 ***************************************
 
+This page contains general code elements that are common
+for package documentation.
+
 .. contents:: Table of Contents
 
-:mod:`test_py_module`
-=====================
+Pandas DataFrame
+================
+
+.. currentmodule:: pandas
+
+.. autosummary::
+   :toctree: api/
+
+   DataFrame
+   DataFrame.index
+   DataFrame.columns
+   DataFrame.dtypes
+   DataFrame.ftypes
+   DataFrame.get_dtype_counts
+   DataFrame.get_ftype_counts
+   DataFrame.select_dtypes
+   DataFrame.values
+
+
+:mod:`pandas.datetime`
+======================
 
-.. automodule:: test_py_module.test
+.. automodule:: pandas.datetime
     :members:
-    :private-members:
-    :special-members:
 
 
 C++ API
diff --git a/docs/demo/index.rst b/docs/demo/index.rst
@@ -0,0 +1,24 @@
+=========
+Demo site
+=========
+
+This is a simple demonstration site to show off a few visual
+and structural elements of the theme. Click the sections on
+the left sidebar to see how various elements look on this theme.
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+    :caption: Demo Documentation
+
+    structure
+    api
+    demo
+    lists_tables
+
+.. toctree::
+    :maxdepth: 3
+    :numbered:
+    :caption: This is an incredibly long caption for a long menu
+
+    long
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,10 @@
-.. include:: ../README.rst
+=======================
+The Pandas Sphinx Theme
+=======================
+
+This is a simple Sphinx theme for use by the Pandas and
+PyData community. This site is a guide for using the theme,
+and a demo for how it looks with various elements.
 
 .. toctree::
    :caption: Theme Documentation
@@ -9,24 +15,9 @@
    contributing
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :hidden:
 
+   demo/index
    changelog
 
-.. toctree::
-    :maxdepth: 2
-    :numbered:
-    :caption: Demo Documentation
-
-    demo/structure
-    demo/demo
-    demo/lists_tables
-    demo/api
-
-.. toctree::
-    :maxdepth: 3
-    :numbered:
-    :caption: This is an incredibly long caption for a long menu
-
-    demo/long

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@`
`32`	`32`	`# ones.`
`33`	`33`
`34`	`34`	`extensions = [`
	`35`	`+ 'sphinx.ext.autodoc',`
	`36`	`+ 'sphinx.ext.autosummary'`
`35`	`37`	`]`
`36`	`38`
`37`	`39`	`# Add any paths that contain templates here, relative to this directory.`