Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VCS API Doc #16

Merged
merged 3 commits into from Oct 3, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
@@ -0,0 +1,5 @@
*.pyc
*.egg-info
build/
docs/_build
dist/
5 changes: 5 additions & 0 deletions docs/API/Canvas.rst
@@ -0,0 +1,5 @@
Canvas
------

.. automodule:: vcs.Canvas
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/boxfill.rst
@@ -0,0 +1,4 @@
boxfill
-------
.. automodule:: vcs.boxfill
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/dv3d.rst
@@ -0,0 +1,4 @@
dv3d
----
.. automodule:: vcs.dv3d
:members:
15 changes: 15 additions & 0 deletions docs/API/graphics/gm.rst
@@ -0,0 +1,15 @@
Graphics Methods
----------------

Graphics methods are VCS' objects for configuring your visualization's data representation. They allow you to set levels, colors, subset your data, set patterns, and much more.

.. toctree::

boxfill
dv3d
isofill
isoline
meshfill
taylor
unified1D
vector
4 changes: 4 additions & 0 deletions docs/API/graphics/isofill.rst
@@ -0,0 +1,4 @@
isofill
-------
.. automodule:: vcs.isofill
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/isoline.rst
@@ -0,0 +1,4 @@
isoline
-------
.. automodule:: vcs.isoline
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/meshfill.rst
@@ -0,0 +1,4 @@
meshfill
--------
.. automodule:: vcs.meshfill
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/taylor.rst
@@ -0,0 +1,4 @@
taylor
------
.. automodule:: vcs.taylor
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/unified1D.rst
@@ -0,0 +1,4 @@
unified1D
---------
.. automodule:: vcs.unified1D
:members:
4 changes: 4 additions & 0 deletions docs/API/graphics/vector.rst
@@ -0,0 +1,4 @@
vector
------
.. automodule:: vcs.vector
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/animate_helper.rst
@@ -0,0 +1,4 @@
animate_helper
--------------
.. automodule:: vcs.animate_helper
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/colormap.rst
@@ -0,0 +1,4 @@
colormap
--------
.. automodule:: vcs.colormap
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/colors.rst
@@ -0,0 +1,4 @@
colors
------
.. automodule:: vcs.colors
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/displayplot.rst
@@ -0,0 +1,4 @@
displayplot
-----------
.. automodule:: vcs.displayplot
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/error.rst
@@ -0,0 +1,4 @@
error
-----
.. automodule:: vcs.error
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/manageElements.rst
@@ -0,0 +1,4 @@
manageElements
--------------
.. automodule:: vcs.manageElements
:members:
17 changes: 17 additions & 0 deletions docs/API/misc/misc.rst
@@ -0,0 +1,17 @@
Miscellaneous Modules
---------------------

These are a variety of modules from VCS that help out with useful functionality.

.. toctree::

animate_helper
projection
colormap
colors
displayplot
error
manageElements
queries
utils
vcshelp
4 changes: 4 additions & 0 deletions docs/API/misc/projection.rst
@@ -0,0 +1,4 @@
projection
----------
.. automodule:: vcs.projection
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/queries.rst
@@ -0,0 +1,4 @@
queries
-------
.. automodule:: vcs.queries
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/utils.rst
@@ -0,0 +1,4 @@
utils
-----
.. automodule:: vcs.utils
:members:
4 changes: 4 additions & 0 deletions docs/API/misc/vcshelp.rst
@@ -0,0 +1,4 @@
vcshelp
-------
.. automodule:: vcs.vcshelp
:members:
4 changes: 4 additions & 0 deletions docs/API/secondary/fillarea.rst
@@ -0,0 +1,4 @@
fillarea
--------
.. automodule:: vcs.fillarea
:members:
13 changes: 13 additions & 0 deletions docs/API/secondary/gms.rst
@@ -0,0 +1,13 @@
Secondary Graphics Methods
--------------------------

Secondary graphics methods define primitives that can be used to create arbitrary shapes, lines, glyphs, and labels on your visualization.

.. toctree::

fillarea
line
marker
textcombined
textorientation
texttable
4 changes: 4 additions & 0 deletions docs/API/secondary/line.rst
@@ -0,0 +1,4 @@
line
----
.. automodule:: vcs.line
:members:
4 changes: 4 additions & 0 deletions docs/API/secondary/marker.rst
@@ -0,0 +1,4 @@
marker
------
.. automodule:: vcs.marker
:members:
4 changes: 4 additions & 0 deletions docs/API/secondary/textcombined.rst
@@ -0,0 +1,4 @@
textcombined
------------
.. automodule:: vcs.textcombined
:members:
4 changes: 4 additions & 0 deletions docs/API/secondary/textorientation.rst
@@ -0,0 +1,4 @@
textorientation
---------------
.. automodule:: vcs.textorientation
:members:
4 changes: 4 additions & 0 deletions docs/API/secondary/texttable.rst
@@ -0,0 +1,4 @@
texttable
---------
.. automodule:: vcs.texttable
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pboxeslines.rst
@@ -0,0 +1,4 @@
Pboxeslines
-----------
.. automodule:: vcs.Pboxeslines
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pdata.rst
@@ -0,0 +1,4 @@
Pdata
-----
.. automodule:: vcs.Pdata
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pformat.rst
@@ -0,0 +1,4 @@
Pformat
-------
.. automodule:: vcs.Pformat
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Plegend.rst
@@ -0,0 +1,4 @@
Plegend
-------
.. automodule:: vcs.Plegend
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Ptext.rst
@@ -0,0 +1,4 @@
Ptext
-----
.. automodule:: vcs.Ptext
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pxlabels.rst
@@ -0,0 +1,4 @@
Pxlabels
--------
.. automodule:: vcs.Pxlabels
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pxtickmarks.rst
@@ -0,0 +1,4 @@
Pxtickmarks
-----------
.. automodule:: vcs.Pxtickmarks
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pylabels.rst
@@ -0,0 +1,4 @@
Pylabels
--------
.. automodule:: vcs.Pylabels
:members:
4 changes: 4 additions & 0 deletions docs/API/template/Pytickmarks.rst
@@ -0,0 +1,4 @@
Pytickmarks
-----------
.. automodule:: vcs.Pytickmarks
:members:
17 changes: 17 additions & 0 deletions docs/API/template/templ.rst
@@ -0,0 +1,17 @@
Templating
----------

Templates define the layout of your visualization. The Template object is used to lay out labels, lines, tick marks, etc.; it uses the P* objects to do so.

.. toctree::

template
Pboxeslines
Pdata
Pformat
Plegend
Ptext
Pxlabels
Pxtickmarks
Pylabels
Pytickmarks
4 changes: 4 additions & 0 deletions docs/API/template/template.rst
@@ -0,0 +1,4 @@
template
--------
.. automodule:: vcs.template
:members:
14 changes: 14 additions & 0 deletions docs/API/vcs.rst
@@ -0,0 +1,14 @@
=====================
VCS API Documentation
=====================

.. automodule:: vcs
:members:

.. toctree::

Canvas
graphics/gm
template/templ
secondary/gms
misc/misc
8 changes: 5 additions & 3 deletions docs/index.rst
Expand Up @@ -50,10 +50,12 @@ Table of contents

user-guide
developer-guide
reference
quick-reference

API index
---------

* :ref:`genindex`
* :ref:`modindex`VCS
.. toctree::
:maxdepth: 3

API/vcs
2 changes: 1 addition & 1 deletion docs/reference.rst → docs/quick-reference.rst
@@ -1,4 +1,4 @@
VCS Reference Guide
VCS Quick Reference
--------------------

init
Expand Down