From a2fe5c2ad336d40c02cff3c9ae4aa3c45c2517a5 Mon Sep 17 00:00:00 2001 From: embrown Date: Thu, 29 Sep 2016 13:16:09 -0700 Subject: [PATCH 1/3] adding API documentation to docs --- docs/API/Canvas.rst | 5 +++++ docs/API/graphics/boxfill.rst | 4 ++++ docs/API/graphics/dv3d.rst | 4 ++++ docs/API/graphics/gm.rst | 15 +++++++++++++++ docs/API/graphics/isofill.rst | 4 ++++ docs/API/graphics/isoline.rst | 4 ++++ docs/API/graphics/meshfill.rst | 4 ++++ docs/API/graphics/taylor.rst | 4 ++++ docs/API/graphics/unified1D.rst | 4 ++++ docs/API/graphics/vector.rst | 4 ++++ docs/API/misc/animate_helper.rst | 4 ++++ docs/API/misc/colormap.rst | 4 ++++ docs/API/misc/colors.rst | 4 ++++ docs/API/misc/displayplot.rst | 4 ++++ docs/API/misc/error.rst | 4 ++++ docs/API/misc/manageElements.rst | 4 ++++ docs/API/misc/misc.rst | 17 +++++++++++++++++ docs/API/misc/projection.rst | 4 ++++ docs/API/misc/queries.rst | 4 ++++ docs/API/misc/utils.rst | 4 ++++ docs/API/misc/vcshelp.rst | 4 ++++ docs/API/secondary/fillarea.rst | 4 ++++ docs/API/secondary/gms.rst | 13 +++++++++++++ docs/API/secondary/line.rst | 4 ++++ docs/API/secondary/marker.rst | 4 ++++ docs/API/secondary/textcombined.rst | 4 ++++ docs/API/secondary/textorientation.rst | 4 ++++ docs/API/secondary/texttable.rst | 4 ++++ docs/API/template/Pboxeslines.rst | 4 ++++ docs/API/template/Pdata.rst | 4 ++++ docs/API/template/Pformat.rst | 4 ++++ docs/API/template/Plegend.rst | 4 ++++ docs/API/template/Ptext.rst | 4 ++++ docs/API/template/Pxlabels.rst | 4 ++++ docs/API/template/Pxtickmarks.rst | 4 ++++ docs/API/template/Pylabels.rst | 4 ++++ docs/API/template/Pytickmarks.rst | 4 ++++ docs/API/template/templ.rst | 17 +++++++++++++++++ docs/API/template/template.rst | 4 ++++ docs/API/vcs.rst | 14 ++++++++++++++ docs/index.rst | 6 ++++-- 41 files changed, 221 insertions(+), 2 deletions(-) create mode 100644 docs/API/Canvas.rst create mode 100644 docs/API/graphics/boxfill.rst create mode 100644 docs/API/graphics/dv3d.rst create mode 100644 docs/API/graphics/gm.rst create mode 100644 docs/API/graphics/isofill.rst create mode 100644 docs/API/graphics/isoline.rst create mode 100644 docs/API/graphics/meshfill.rst create mode 100644 docs/API/graphics/taylor.rst create mode 100644 docs/API/graphics/unified1D.rst create mode 100644 docs/API/graphics/vector.rst create mode 100644 docs/API/misc/animate_helper.rst create mode 100644 docs/API/misc/colormap.rst create mode 100644 docs/API/misc/colors.rst create mode 100644 docs/API/misc/displayplot.rst create mode 100644 docs/API/misc/error.rst create mode 100644 docs/API/misc/manageElements.rst create mode 100644 docs/API/misc/misc.rst create mode 100644 docs/API/misc/projection.rst create mode 100644 docs/API/misc/queries.rst create mode 100644 docs/API/misc/utils.rst create mode 100644 docs/API/misc/vcshelp.rst create mode 100644 docs/API/secondary/fillarea.rst create mode 100644 docs/API/secondary/gms.rst create mode 100644 docs/API/secondary/line.rst create mode 100644 docs/API/secondary/marker.rst create mode 100644 docs/API/secondary/textcombined.rst create mode 100644 docs/API/secondary/textorientation.rst create mode 100644 docs/API/secondary/texttable.rst create mode 100644 docs/API/template/Pboxeslines.rst create mode 100644 docs/API/template/Pdata.rst create mode 100644 docs/API/template/Pformat.rst create mode 100644 docs/API/template/Plegend.rst create mode 100644 docs/API/template/Ptext.rst create mode 100644 docs/API/template/Pxlabels.rst create mode 100644 docs/API/template/Pxtickmarks.rst create mode 100644 docs/API/template/Pylabels.rst create mode 100644 docs/API/template/Pytickmarks.rst create mode 100644 docs/API/template/templ.rst create mode 100644 docs/API/template/template.rst create mode 100644 docs/API/vcs.rst diff --git a/docs/API/Canvas.rst b/docs/API/Canvas.rst new file mode 100644 index 000000000..e73daee8d --- /dev/null +++ b/docs/API/Canvas.rst @@ -0,0 +1,5 @@ +Canvas +------ + +.. automodule:: vcs.Canvas + :members: diff --git a/docs/API/graphics/boxfill.rst b/docs/API/graphics/boxfill.rst new file mode 100644 index 000000000..f640520b1 --- /dev/null +++ b/docs/API/graphics/boxfill.rst @@ -0,0 +1,4 @@ +boxfill +------- +.. automodule:: vcs.boxfill + :members: \ No newline at end of file diff --git a/docs/API/graphics/dv3d.rst b/docs/API/graphics/dv3d.rst new file mode 100644 index 000000000..752bd53a4 --- /dev/null +++ b/docs/API/graphics/dv3d.rst @@ -0,0 +1,4 @@ +dv3d +---- +.. automodule:: vcs.dv3d + :members: \ No newline at end of file diff --git a/docs/API/graphics/gm.rst b/docs/API/graphics/gm.rst new file mode 100644 index 000000000..70bc604c3 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/API/graphics/isofill.rst b/docs/API/graphics/isofill.rst new file mode 100644 index 000000000..8c262e532 --- /dev/null +++ b/docs/API/graphics/isofill.rst @@ -0,0 +1,4 @@ +isofill +------- +.. automodule:: vcs.isofill + :members: \ No newline at end of file diff --git a/docs/API/graphics/isoline.rst b/docs/API/graphics/isoline.rst new file mode 100644 index 000000000..3a4d8bbec --- /dev/null +++ b/docs/API/graphics/isoline.rst @@ -0,0 +1,4 @@ +isoline +------- +.. automodule:: vcs.isoline + :members: \ No newline at end of file diff --git a/docs/API/graphics/meshfill.rst b/docs/API/graphics/meshfill.rst new file mode 100644 index 000000000..033dea9c8 --- /dev/null +++ b/docs/API/graphics/meshfill.rst @@ -0,0 +1,4 @@ +meshfill +-------- +.. automodule:: vcs.meshfill + :members: \ No newline at end of file diff --git a/docs/API/graphics/taylor.rst b/docs/API/graphics/taylor.rst new file mode 100644 index 000000000..f5ee71832 --- /dev/null +++ b/docs/API/graphics/taylor.rst @@ -0,0 +1,4 @@ +taylor +------ +.. automodule:: vcs.taylor + :members: \ No newline at end of file diff --git a/docs/API/graphics/unified1D.rst b/docs/API/graphics/unified1D.rst new file mode 100644 index 000000000..208233f6b --- /dev/null +++ b/docs/API/graphics/unified1D.rst @@ -0,0 +1,4 @@ +unified1D +--------- +.. automodule:: vcs.unified1D + :members: \ No newline at end of file diff --git a/docs/API/graphics/vector.rst b/docs/API/graphics/vector.rst new file mode 100644 index 000000000..796c8bd8e --- /dev/null +++ b/docs/API/graphics/vector.rst @@ -0,0 +1,4 @@ +vector +------ +.. automodule:: vcs.vector + :members: \ No newline at end of file diff --git a/docs/API/misc/animate_helper.rst b/docs/API/misc/animate_helper.rst new file mode 100644 index 000000000..edd393380 --- /dev/null +++ b/docs/API/misc/animate_helper.rst @@ -0,0 +1,4 @@ +animate_helper +-------------- +.. automodule:: vcs.animate_helper + :members: \ No newline at end of file diff --git a/docs/API/misc/colormap.rst b/docs/API/misc/colormap.rst new file mode 100644 index 000000000..c0f0e5dce --- /dev/null +++ b/docs/API/misc/colormap.rst @@ -0,0 +1,4 @@ +colormap +-------- +.. automodule:: vcs.colormap + :members: \ No newline at end of file diff --git a/docs/API/misc/colors.rst b/docs/API/misc/colors.rst new file mode 100644 index 000000000..a48a802c9 --- /dev/null +++ b/docs/API/misc/colors.rst @@ -0,0 +1,4 @@ +colors +------ +.. automodule:: vcs.colors + :members: \ No newline at end of file diff --git a/docs/API/misc/displayplot.rst b/docs/API/misc/displayplot.rst new file mode 100644 index 000000000..ce6b4d528 --- /dev/null +++ b/docs/API/misc/displayplot.rst @@ -0,0 +1,4 @@ +displayplot +----------- +.. automodule:: vcs.displayplot + :members: \ No newline at end of file diff --git a/docs/API/misc/error.rst b/docs/API/misc/error.rst new file mode 100644 index 000000000..0672a8db0 --- /dev/null +++ b/docs/API/misc/error.rst @@ -0,0 +1,4 @@ +error +----- +.. automodule:: vcs.error + :members: \ No newline at end of file diff --git a/docs/API/misc/manageElements.rst b/docs/API/misc/manageElements.rst new file mode 100644 index 000000000..48e21b689 --- /dev/null +++ b/docs/API/misc/manageElements.rst @@ -0,0 +1,4 @@ +manageElements +-------------- +.. automodule:: vcs.manageElements + :members: \ No newline at end of file diff --git a/docs/API/misc/misc.rst b/docs/API/misc/misc.rst new file mode 100644 index 000000000..ae7a37768 --- /dev/null +++ b/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 diff --git a/docs/API/misc/projection.rst b/docs/API/misc/projection.rst new file mode 100644 index 000000000..327a3b1d5 --- /dev/null +++ b/docs/API/misc/projection.rst @@ -0,0 +1,4 @@ +projection +---------- +.. automodule:: vcs.projection + :members: \ No newline at end of file diff --git a/docs/API/misc/queries.rst b/docs/API/misc/queries.rst new file mode 100644 index 000000000..09decb781 --- /dev/null +++ b/docs/API/misc/queries.rst @@ -0,0 +1,4 @@ +queries +------- +.. automodule:: vcs.queries + :members: \ No newline at end of file diff --git a/docs/API/misc/utils.rst b/docs/API/misc/utils.rst new file mode 100644 index 000000000..6b000407c --- /dev/null +++ b/docs/API/misc/utils.rst @@ -0,0 +1,4 @@ +utils +----- +.. automodule:: vcs.utils + :members: \ No newline at end of file diff --git a/docs/API/misc/vcshelp.rst b/docs/API/misc/vcshelp.rst new file mode 100644 index 000000000..c414b1b78 --- /dev/null +++ b/docs/API/misc/vcshelp.rst @@ -0,0 +1,4 @@ +vcshelp +------- +.. automodule:: vcs.vcshelp + :members: \ No newline at end of file diff --git a/docs/API/secondary/fillarea.rst b/docs/API/secondary/fillarea.rst new file mode 100644 index 000000000..97d0f85cf --- /dev/null +++ b/docs/API/secondary/fillarea.rst @@ -0,0 +1,4 @@ +fillarea +-------- +.. automodule:: vcs.fillarea + :members: \ No newline at end of file diff --git a/docs/API/secondary/gms.rst b/docs/API/secondary/gms.rst new file mode 100644 index 000000000..4b2339ec8 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/API/secondary/line.rst b/docs/API/secondary/line.rst new file mode 100644 index 000000000..7ed6ab472 --- /dev/null +++ b/docs/API/secondary/line.rst @@ -0,0 +1,4 @@ +line +---- +.. automodule:: vcs.line + :members: \ No newline at end of file diff --git a/docs/API/secondary/marker.rst b/docs/API/secondary/marker.rst new file mode 100644 index 000000000..085d749a1 --- /dev/null +++ b/docs/API/secondary/marker.rst @@ -0,0 +1,4 @@ +marker +------ +.. automodule:: vcs.marker + :members: \ No newline at end of file diff --git a/docs/API/secondary/textcombined.rst b/docs/API/secondary/textcombined.rst new file mode 100644 index 000000000..03ef2287e --- /dev/null +++ b/docs/API/secondary/textcombined.rst @@ -0,0 +1,4 @@ +textcombined +------------ +.. automodule:: vcs.textcombined + :members: \ No newline at end of file diff --git a/docs/API/secondary/textorientation.rst b/docs/API/secondary/textorientation.rst new file mode 100644 index 000000000..baa87bce8 --- /dev/null +++ b/docs/API/secondary/textorientation.rst @@ -0,0 +1,4 @@ +textorientation +--------------- +.. automodule:: vcs.textorientation + :members: \ No newline at end of file diff --git a/docs/API/secondary/texttable.rst b/docs/API/secondary/texttable.rst new file mode 100644 index 000000000..29a054986 --- /dev/null +++ b/docs/API/secondary/texttable.rst @@ -0,0 +1,4 @@ +texttable +--------- +.. automodule:: vcs.texttable + :members: \ No newline at end of file diff --git a/docs/API/template/Pboxeslines.rst b/docs/API/template/Pboxeslines.rst new file mode 100644 index 000000000..38ed328de --- /dev/null +++ b/docs/API/template/Pboxeslines.rst @@ -0,0 +1,4 @@ +Pboxeslines +----------- +.. automodule:: vcs.Pboxeslines + :members: \ No newline at end of file diff --git a/docs/API/template/Pdata.rst b/docs/API/template/Pdata.rst new file mode 100644 index 000000000..40ce6560d --- /dev/null +++ b/docs/API/template/Pdata.rst @@ -0,0 +1,4 @@ +Pdata +----- +.. automodule:: vcs.Pdata + :members: \ No newline at end of file diff --git a/docs/API/template/Pformat.rst b/docs/API/template/Pformat.rst new file mode 100644 index 000000000..edb8c9bcf --- /dev/null +++ b/docs/API/template/Pformat.rst @@ -0,0 +1,4 @@ +Pformat +------- +.. automodule:: vcs.Pformat + :members: \ No newline at end of file diff --git a/docs/API/template/Plegend.rst b/docs/API/template/Plegend.rst new file mode 100644 index 000000000..520b0035f --- /dev/null +++ b/docs/API/template/Plegend.rst @@ -0,0 +1,4 @@ +Plegend +------- +.. automodule:: vcs.Plegend + :members: \ No newline at end of file diff --git a/docs/API/template/Ptext.rst b/docs/API/template/Ptext.rst new file mode 100644 index 000000000..8780df93a --- /dev/null +++ b/docs/API/template/Ptext.rst @@ -0,0 +1,4 @@ +Ptext +----- +.. automodule:: vcs.Ptext + :members: \ No newline at end of file diff --git a/docs/API/template/Pxlabels.rst b/docs/API/template/Pxlabels.rst new file mode 100644 index 000000000..e65d382ca --- /dev/null +++ b/docs/API/template/Pxlabels.rst @@ -0,0 +1,4 @@ +Pxlabels +-------- +.. automodule:: vcs.Pxlabels + :members: \ No newline at end of file diff --git a/docs/API/template/Pxtickmarks.rst b/docs/API/template/Pxtickmarks.rst new file mode 100644 index 000000000..73602b797 --- /dev/null +++ b/docs/API/template/Pxtickmarks.rst @@ -0,0 +1,4 @@ +Pxtickmarks +----------- +.. automodule:: vcs.Pxtickmarks + :members: \ No newline at end of file diff --git a/docs/API/template/Pylabels.rst b/docs/API/template/Pylabels.rst new file mode 100644 index 000000000..e4cc37ac4 --- /dev/null +++ b/docs/API/template/Pylabels.rst @@ -0,0 +1,4 @@ +Pylabels +-------- +.. automodule:: vcs.Pylabels + :members: \ No newline at end of file diff --git a/docs/API/template/Pytickmarks.rst b/docs/API/template/Pytickmarks.rst new file mode 100644 index 000000000..28a65cf22 --- /dev/null +++ b/docs/API/template/Pytickmarks.rst @@ -0,0 +1,4 @@ +Pytickmarks +----------- +.. automodule:: vcs.Pytickmarks + :members: \ No newline at end of file diff --git a/docs/API/template/templ.rst b/docs/API/template/templ.rst new file mode 100644 index 000000000..3599b5b5b --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/API/template/template.rst b/docs/API/template/template.rst new file mode 100644 index 000000000..c31376e97 --- /dev/null +++ b/docs/API/template/template.rst @@ -0,0 +1,4 @@ +template +-------- +.. automodule:: vcs.template + :members: \ No newline at end of file diff --git a/docs/API/vcs.rst b/docs/API/vcs.rst new file mode 100644 index 000000000..14a59e02e --- /dev/null +++ b/docs/API/vcs.rst @@ -0,0 +1,14 @@ +=== +VCS +=== + +.. automodule:: vcs + :members: + +.. toctree:: + + Canvas + graphics/gm + template/templ + secondary/gms + misc/misc diff --git a/docs/index.rst b/docs/index.rst index 1fcb27b4e..a8671540f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -55,5 +55,7 @@ Table of contents API index --------- -* :ref:`genindex` -* :ref:`modindex`VCS \ No newline at end of file +.. toctree:: + :maxdepth: 3 + + API/vcs \ No newline at end of file From 2ac607a1edc120e06ce3c4daf690da87b490718a Mon Sep 17 00:00:00 2001 From: embrown Date: Thu, 29 Sep 2016 14:21:48 -0700 Subject: [PATCH 2/3] Renamed VCS Reference Guide to VCS Quick Reference --- docs/API/vcs.rst | 6 +++--- docs/index.rst | 2 +- docs/{reference.rst => quick-reference.rst} | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) rename docs/{reference.rst => quick-reference.rst} (98%) diff --git a/docs/API/vcs.rst b/docs/API/vcs.rst index 14a59e02e..441e356e3 100644 --- a/docs/API/vcs.rst +++ b/docs/API/vcs.rst @@ -1,6 +1,6 @@ -=== -VCS -=== +===================== +VCS API Documentation +===================== .. automodule:: vcs :members: diff --git a/docs/index.rst b/docs/index.rst index a8671540f..f2c0b7c6f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,7 +50,7 @@ Table of contents user-guide developer-guide - reference + quick-reference API index --------- diff --git a/docs/reference.rst b/docs/quick-reference.rst similarity index 98% rename from docs/reference.rst rename to docs/quick-reference.rst index 73db692bf..14f6af660 100644 --- a/docs/reference.rst +++ b/docs/quick-reference.rst @@ -1,4 +1,4 @@ -VCS Reference Guide +VCS Quick Reference -------------------- init From e8e088f413c3d14c9d43172d19b8e20e1ff4ceb6 Mon Sep 17 00:00:00 2001 From: Sam Fries Date: Mon, 3 Oct 2016 13:56:46 -0700 Subject: [PATCH 3/3] Ignores build artefacts --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..d2cdc1587 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*.pyc +*.egg-info +build/ +docs/_build +dist/