Update docs

Author: heitzmann

docs/conf.py

@@ -32,9 +32,22 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'numpydoc',
+    'sphinx.ext.napoleon',
 ]
 
+# Napoleon settings
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = False
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = True
+napoleon_use_param = True
+napoleon_use_rtype = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/construction.rst renamed to docs/geometry.rst

@@ -1,34 +1,15 @@
-Main API
-========
+#####################
+Geometry Construction
+#####################
 
 .. automodule:: gdspy
 
-
+*******
 Classes
-~~~~~~~
-
-GdsLibrary
-----------
-
-.. autoclass:: gdspy.GdsLibrary
-   :members:
-   :no-undoc-members:
-   :inherited-members:
-   :show-inheritance:
-
-
-Cell
-----
-
-.. autoclass:: gdspy.Cell
-   :members:
-   :undoc-members:
-   :inherited-members:
-   :show-inheritance:
-
+*******
 
 Polygon
--------
+=======
 
 .. autoclass:: gdspy.Polygon
    :members:
@@ -38,7 +19,7 @@ Polygon
 
 
 Rectangle
----------
+=========
 
 .. autoclass:: gdspy.Rectangle
    :members:
@@ -48,7 +29,7 @@ Rectangle
 
 
 Round
------
+=====
 
 .. autoclass:: gdspy.Round
    :members:
@@ -58,7 +39,7 @@ Round
 
 
 PolygonSet
-----------
+==========
 
 .. autoclass:: gdspy.PolygonSet
    :members:
@@ -68,7 +49,7 @@ PolygonSet
 
 
 Path
-----
+====
 
 .. autoclass:: gdspy.Path
    :members:
@@ -78,7 +59,7 @@ Path
 
 
 PolyPath
---------
+========
 
 .. autoclass:: gdspy.PolyPath
    :members:
@@ -88,7 +69,7 @@ PolyPath
 
 
 L1Path
-------
+======
 
 .. autoclass:: gdspy.L1Path
    :members:
@@ -98,7 +79,7 @@ L1Path
 
 
 Text
-----
+====
 
 .. autoclass:: gdspy.Text
    :members:
@@ -107,60 +88,40 @@ Text
    :show-inheritance:
 
 
-CellReference
--------------
-
-.. autoclass:: gdspy.CellReference
-   :members:
-   :undoc-members:
-   :inherited-members:
-   :show-inheritance:
-
-
-CellArray
----------
-
-.. autoclass:: gdspy.CellArray
-   :members:
-   :undoc-members:
-   :inherited-members:
-   :show-inheritance:
-
-
+*********
 Functions
-~~~~~~~~~
+*********
 
 fast_boolean
-------------
+============
 
 .. autofunction:: gdspy.fast_boolean
 
 
 boolean
--------
+=======
 
 .. autofunction:: gdspy.boolean
 
 offset
-------
+======
 
 .. autofunction:: gdspy.offset
 
 
 slice
------
+=====
 
 .. autofunction:: gdspy.slice
 
 
 inside
-------
+======
 
 .. autofunction:: gdspy.inside
 
 
 copy
-----
+====
 
 .. autofunction:: gdspy.copy
-

docs/index.rst

@@ -1,5 +1,6 @@
+#####################
 gdspy's Documentation
-=====================
+#####################
 
 For installation instructions and other information, please check out the `GitHub <https://github.com/heitzmann/gdspy>`_ repository or the README file included with the source.
 
@@ -8,11 +9,12 @@ For installation instructions and other information, please check out the `GitHu
    :caption: Table of Contents
 
    tutorial
-   construction
-   io
+   geometry
+   library
 
+*******
 Support
-=======
+*******
 
 Help support the development of gdspy by donating:
 

docs/io.rst

@@ -0,0 +1,84 @@
+#############
+GDSII Library
+#############
+
+.. automodule:: gdspy
+
+*******
+Classes
+*******
+
+Cell
+====
+
+.. autoclass:: gdspy.Cell
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+
+CellReference
+=============
+
+.. autoclass:: gdspy.CellReference
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+
+CellArray
+=========
+
+.. autoclass:: gdspy.CellArray
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+
+GdsLibrary
+==========
+
+.. autoclass:: gdspy.GdsLibrary
+   :members:
+   :no-undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+
+GdsWriter
+=========
+
+.. autoclass:: gdspy.GdsWriter
+   :members:
+   :no-undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+
+LayoutViewer
+============
+
+.. autoclass:: gdspy.LayoutViewer
+   :members:
+   :no-undoc-members:
+   :no-inherited-members:
+   :no-show-inheritance:
+
+
+*********
+Functions
+*********
+
+write_gds
+=========
+
+.. autofunction:: gdspy.write_gds
+
+**********
+Attributes
+**********
+
+.. autodata:: current_library

docs/library.rst

@@ -1,5 +1,6 @@
+###########
 Sample File
-===========
+###########
 
 The following code is a sample to quickly demonstrate some features of gdspy.
 

docs/tutorial.rst

@@ -1,4 +1,3 @@
 setuptools
 numpy
-numpydoc
 future; python_version < "3"