openstack
/
deb-python-pydotplus
Code Issues Proposed changes

new: dev: Added basic autogenerated API reference.

This commit is contained in:
Carlos Miguel Jenkins Perez 2014-12-01 18:49:33 -06:00
parent e229ddd0d4
commit c0219c8be6
4 changed files with 97 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/conf.py
View File

@ -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.

90
doc/index.rst
View File

@ -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 <carlos@jenkins.co.cr>
Copyright (c) 2014 Lance Hepler
Copyright (c) 2004-2011 Ero Carrera <ero@dkbza.org>
Copyright (c) 2004-2007 Michael Krause <michael@krause-software.de>
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.

24
doc/reference.rst Normal file
View File

@ -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:

10
lib/pydotplus/graphviz.py
View File

@ -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 <ero.carrera@gmail.com>
"""
from __future__ import division, print_function