From c0219c8be6bd7a24143fbe66c0dd9022b7fa49e4 Mon Sep 17 00:00:00 2001 From: Carlos Miguel Jenkins Perez Date: Mon, 1 Dec 2014 18:49:33 -0600 Subject: [PATCH] new: dev: Added basic autogenerated API reference. --- doc/conf.py | 4 +- doc/index.rst | 90 ++++++++++++++++++++++++++++++--------- doc/reference.rst | 24 +++++++++++ lib/pydotplus/graphviz.py | 10 ----- 4 files changed, 97 insertions(+), 31 deletions(-) create mode 100644 doc/reference.rst diff --git a/doc/conf.py b/doc/conf.py index 50957bf..e2a9d2f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -55,9 +55,9 @@ copyright = u'2014, PyDotPlus Developers' # built documents. # # The short X.Y version. -version = '0.1.0' +version = '' # The full version, including alpha/beta/rc tags. -release = '0.1.0' +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/index.rst b/doc/index.rst index dac28cf..29f2bb5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,22 +1,74 @@ -.. PyDotPlus documentation master file, created by - sphinx-quickstart on Mon Dec 1 15:52:06 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to PyDotPlus's documentation! -===================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - - -Indices and tables +================== +PyDotPlus Homepage ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +PyDotPlus is an improved version of the old pydot project that provides a +Python Interface to Graphviz's Dot language. + +Quick Guide +=========== + +.. warning:: + + Please Write. + + +API Reference +============= + +.. toctree:: + :maxdepth: 3 + + reference + + +Installation +============ + +For the latest stable version: + +:: + + pip install pydotplus + +For the development version: + +:: + + pip install https://github.com/carlos-jenkins/pydotplus/archive/master.zip + + +Contribute +========== + + https://github.com/carlos-jenkins/pydotplus + + +License +======= + +:: + + Copyright (c) 2014 Carlos Jenkins + Copyright (c) 2014 Lance Hepler + Copyright (c) 2004-2011 Ero Carrera + Copyright (c) 2004-2007 Michael Krause + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. diff --git a/doc/reference.rst b/doc/reference.rst new file mode 100644 index 0000000..bda02b1 --- /dev/null +++ b/doc/reference.rst @@ -0,0 +1,24 @@ +.. toctree:: + +============= +API Reference +============= + +.. contents:: Table of Contents + :local: + + +GraphViz Module ++++++++++++++++ + +.. automodule:: pydotplus.graphviz + :members: + :undoc-members: + + +Parser Module ++++++++++++++ + +.. automodule:: pydotplus.parser + :members: + :undoc-members: \ No newline at end of file diff --git a/lib/pydotplus/graphviz.py b/lib/pydotplus/graphviz.py index 2683e39..cd765dc 100644 --- a/lib/pydotplus/graphviz.py +++ b/lib/pydotplus/graphviz.py @@ -28,16 +28,6 @@ Graphviz's dot language Python interface. This module provides with a full interface to create handle modify and process graphs in Graphviz's dot language. - -References: - -pydot Homepage: http://code.google.com/p/pydot/ -Graphviz: http://www.graphviz.org/ -DOT Language: http://www.graphviz.org/doc/info/lang.html - -Programmed and tested with Graphviz 2.26.3 and Python 2.6 on OSX 10.6.4 - -Copyright (c) 2005-2011 Ero Carrera """ from __future__ import division, print_function