gaphor/docs/index.txt

######################
Documentation contents
######################

  *The source is the documentation.*

Well, not for us.

Currently, there's not a lot of documentation though. For those of you interested in Gaphor there's:

* A :doc:`manual <manual/index>`. It outlines some of the ideas in and behind Gaphor.
* The :ref:`tech-section` contains some interesting articles about the technology that drives Gaphor and Gaphas, Gaphor's canvas widget.

If you're into writing plug-ins for Gaphor you should have a look at our fabulous `Hello world <http://github.com/amolenaar/gaphor.plugins.helloworld>`_ plug-in.

.. toctree::
   :maxdepth: 2

   manual/index

Running Gaphor on different platforms:

.. toctree::
   :maxdepth: 1

   linux
   win32
   custominstall


.. _tech-section:

Tech section
------------

.. toctree::
   :maxdepth: 1

   framework
   model
   stereotypes
   datamodel
   connect
   actions
   items
   services
   so
   storage
   undo
   xml-format

.. toctree::
   :maxdepth: 2

External links
^^^^^^^^^^^^^^

* You should definitely check out http://www.agilemodeling.com.

  * The `UML diagrams <http://www.agilemodeling.com/essays/umlDiagrams.htm>`_ (although Gaphor does not see it that black-and-white).
  * http://www.agilemodeling.com/essays/
* The `official UML metamodel specification <http://www.omg.org/technology/documents/modeling_spec_catalog.htm#UML>`_. This ''is'' our data model.


..
   # vim:syntax=rst
Updated quite a bit of documentation. Everything generates (abeit wiki markup). 2010-01-28 08:21:40 +01:00			`######################`
			`Documentation contents`
			`######################`

More documentation updates/cleanup 2010-01-29 13:35:43 +01:00			`The source is the documentation.`

			`Well, not for us.`

Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			`Currently, there's not a lot of documentation though. For those of you interested in Gaphor there's:`
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00
Small update on manual 2010-04-20 07:13:47 +02:00			* A :doc:`manual <manual/index>`. It outlines some of the ideas in and behind Gaphor.
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00			* The :ref:`tech-section` contains some interesting articles about the technology that drives Gaphor and Gaphas, Gaphor's canvas widget.

Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			If you're into writing plug-ins for Gaphor you should have a look at our fabulous `Hello world <http://github.com/amolenaar/gaphor.plugins.helloworld>`_ plug-in.
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00
Updated quite a bit of documentation. Everything generates (abeit wiki markup). 2010-01-28 08:21:40 +01:00			`.. toctree::`
			`:maxdepth: 2`

			`manual/index`
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00
			`Running Gaphor on different platforms:`

			`.. toctree::`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			`:maxdepth: 1`
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00
Updated quite a bit of documentation. Everything generates (abeit wiki markup). 2010-01-28 08:21:40 +01:00			`linux`
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00			`win32`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			`custominstall`

More documentation updates/cleanup 2010-01-29 13:35:43 +01:00
			`.. _tech-section:`

			`Tech section`
			`------------`

			`.. toctree::`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			`:maxdepth: 1`
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00
			`framework`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			`model`
			`stereotypes`
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00			`datamodel`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00			`connect`
			`actions`
			`items`
Updated quite a bit of documentation. Everything generates (abeit wiki markup). 2010-01-28 08:21:40 +01:00			`services`
			`so`
			`storage`
			`undo`
			`xml-format`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00
			`.. toctree::`
			`:maxdepth: 2`
Updated quite a bit of documentation. Everything generates (abeit wiki markup). 2010-01-28 08:21:40 +01:00
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00			`External links`
			`^^^^^^^^^^^^^^`

			`* You should definitely check out http://www.agilemodeling.com.`
Tidy the docs folder Make the docs consistent RST, correct some typos and grammar. Add a sphinx makefile, remove the epydoc config, ignore a build folder. Add some autodoc entries. 2012-07-31 13:47:24 +01:00
More documentation updates/cleanup 2010-01-29 13:35:43 +01:00			* The `UML diagrams <http://www.agilemodeling.com/essays/umlDiagrams.htm>`_ (although Gaphor does not see it that black-and-white).
			`* http://www.agilemodeling.com/essays/`
			* The `official UML metamodel specification <http://www.omg.org/technology/documents/modeling_spec_catalog.htm#UML>`_. This ''is'' our data model.


Updated quite a bit of documentation. Everything generates (abeit wiki markup). 2010-01-28 08:21:40 +01:00			`..`
			`# vim:syntax=rst`