Fix broken links
Signed-off-by: Dan Yeaw <dan@yeaw.me>
This commit is contained in:
Dan Yeaw
parent
7c94dba49f
commit
1a4c5580e8
@ -1,153 +0,0 @@
|
||||
# Makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS = -a
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
-rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/generic.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/generic.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/generic"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/generic"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
@ -47,13 +47,6 @@ Using per-application event API
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. autoclass:: generic.event.Manager
|
||||
:members: subscribe, subscriber, handle, unsubscribe
|
||||
.. autoclass:: gaphor.misc.generic.event.Manager
|
||||
:members: subscribe, handle, unsubscribe
|
||||
|
||||
Functions below are just aliases for methods of globally instantiated
|
||||
manager:
|
||||
|
||||
.. autofunction:: generic.event.subscribe(handler, event_type)
|
||||
.. autofunction:: generic.event.subscriber(event_type)
|
||||
.. autofunction:: generic.event.handle(event)
|
||||
.. autofunction:: generic.event.unsubscribe(handler, event_type)
|
||||
|
||||
@ -1,45 +0,0 @@
|
||||
Generic programming library for Python
|
||||
======================================
|
||||
|
||||
Generic is trying to provide a Python programmer with primitives for creating
|
||||
reusable software components by employing advanced techniques of OOP and other
|
||||
programming paradigms.
|
||||
|
||||
This documentation suits both needs in a tutorial and an API reference for
|
||||
generic:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
multidispatching
|
||||
event_system
|
||||
registry
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
You can get generic by issuing *easy_install*::
|
||||
|
||||
% easy_install generic
|
||||
|
||||
or *pip* command::
|
||||
|
||||
% pip install generic
|
||||
|
||||
In case you find a bug or have a feature request, please file a ticket at
|
||||
`GitHub Issues`_.
|
||||
|
||||
.. _GitHub Issues: https://github.com/andreypopp/generic/issues
|
||||
|
||||
Development process
|
||||
-------------------
|
||||
|
||||
Development takes place at `GitHub`_, you can clone source code repository with the
|
||||
following command::
|
||||
|
||||
% git clone git://github.com/andreypopp/generic.git
|
||||
|
||||
In case submitting patch or GitHub pull request please ensure you have
|
||||
corresponding tests for your bugfix or new functionality.
|
||||
|
||||
.. _GitHub: https://github.com/andreypopp/generic
|
||||
@ -91,8 +91,8 @@ used for dispatch.
|
||||
API reference
|
||||
-------------
|
||||
|
||||
.. autofunction:: generic.multidispatch.multidispatch
|
||||
.. autofunction:: gaphor.misc.generic.multidispatch.multidispatch
|
||||
|
||||
.. autoclass:: generic.multidispatch.FunctionDispatcher
|
||||
.. autoclass:: gaphor.misc.generic.multidispatch.FunctionDispatcher
|
||||
:members: register
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ Some highlights of the documentation:
|
||||
* 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>`_
|
||||
fabulous `Hello world <https://github.com/gaphor/gaphor.plugins.helloworld>`_
|
||||
plug-in.
|
||||
|
||||
.. toctree::
|
||||
@ -56,6 +56,5 @@ External links
|
||||
|
||||
* 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.
|
||||
|
||||
* The `official UML specification <https://www.omg.org/spec/UML>`_. This ''is'' our data model.
|
||||
|
||||
|
||||
@ -7,38 +7,3 @@ DiagramItem
|
||||
-----------
|
||||
Basic diagram item supporting item style, text elements and stereotypes.
|
||||
|
||||
.. autoclass:: gaphor.diagram.diagramitem.DiagramItem
|
||||
:members:
|
||||
|
||||
ElementItem
|
||||
-----------
|
||||
Rectangular canvas item.
|
||||
|
||||
.. autoclass:: gaphor.diagram.elementitem.ElementItem
|
||||
|
||||
NamedItem
|
||||
---------
|
||||
NamedElement (UML metamodel) representation using rectangular canvas item.
|
||||
|
||||
.. autoclass:: gaphor.diagram.nameditem.NamedItem
|
||||
|
||||
CompartmentItem
|
||||
---------------
|
||||
An item with compartments (i.e. Class or State)
|
||||
|
||||
.. autoclass:: gaphor.diagram.compartment.CompartmentItem
|
||||
|
||||
ClassifierItem
|
||||
--------------
|
||||
Classifer (UML metamodel) representation.
|
||||
|
||||
.. autoclass:: gaphor.diagram.classifier.ClassifierItem
|
||||
|
||||
FeatureItem
|
||||
-----------
|
||||
Diagram representation of UML metamodel classes like property, operation,
|
||||
stereotype attribute, etc.
|
||||
|
||||
.. autoclass:: gaphor.diagram.compartment.FeatureItem
|
||||
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
Gaphor on Linux
|
||||
===============
|
||||
|
||||
Examples of Gaphor and Gaphas RPM spec files can be found in `PLD Linux <http://www.pld-linux.org/ PLD Linux>`_
|
||||
`repository <http://cvs.pld-linux.org/cgi-bin/cvsweb/SPECS/>`_:
|
||||
Examples of Gaphor and Gaphas RPM spec files can be found in `PLD Linux <https://www.pld-linux.org/>`_
|
||||
`repository <https://github.com/pld-linux/>`_:
|
||||
|
||||
* http://cvs.pld-linux.org/cgi-bin/cvsweb/SPECS/python-gaphas.spec
|
||||
* http://cvs.pld-linux.org/cgi-bin/cvsweb/SPECS/gaphor.spec
|
||||
* https://github.com/pld-linux/python-gaphas
|
||||
* https://github.com/pld-linux/gaphor
|
||||
|
||||
Please, do not hesitate to contact us if you need help to create a Linux package
|
||||
for Gaphor or Gaphas.
|
||||
|
||||
@ -51,7 +51,7 @@ through all parameters related to class' operations, one can write::
|
||||
for p in o.ownedParameter:
|
||||
do_something(p)
|
||||
|
||||
Using the ``[:]`` operator items can be traversed more easily [1]_::
|
||||
Using the ``[:]`` operator items can be traversed more easily:
|
||||
|
||||
for o in classes.ownedOperation[:].ownedParameter:
|
||||
do_something(p)
|
||||
@ -66,5 +66,3 @@ It's also possible to provide a query as part of the selection::
|
||||
The variable ``it`` in the query refers to the evaluated object (in this case
|
||||
all operations with a return parameter are taken into account).
|
||||
|
||||
|
||||
.. [1] See http://github.com/amolenaar/gaphor/blob/master/gaphor/misc/listmixins.py
|
||||
|
||||
@ -70,9 +70,9 @@ Example plugin
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
A small example is provided by means of the `Hello world plugin`.
|
||||
Take a look at the files at `Github <https://github.com/amolenaar/gaphor.plugins.helloworld>`_.
|
||||
Take a look at the files at `Github <https://github.com/gaphor/gaphor.plugins.helloworld>`_.
|
||||
|
||||
The `setup.py <https://github.com/amolenaar/gaphor.plugins.helloworld/blob/master/setup.py>`_
|
||||
The `setup.py <https://github.com/gaphor/gaphor.plugins.helloworld/blob/master/setup.py>`_
|
||||
file contains an entry point::
|
||||
|
||||
entry_points = {
|
||||
@ -82,7 +82,7 @@ file contains an entry point::
|
||||
}
|
||||
|
||||
This refers to the class ``HelloWorldPlugin`` in package/module
|
||||
`gaphor.plugins.helloworld <https://github.com/amolenaar/gaphor.plugins.helloworld/blob/master/gaphor/plugins/helloworld/__init__.py>`_.
|
||||
`gaphor.plugins.helloworld <https://github.com/gaphor/gaphor.plugins.helloworld/blob/master/gaphor/plugins/helloworld/__init__.py>`_.
|
||||
|
||||
Here is a stripped version of the hello world class::
|
||||
|
||||
|
||||
@ -139,10 +139,10 @@ References
|
||||
----------
|
||||
|
||||
A Framework for Undoing Actions in Collaborative Systems
|
||||
http://www.eecs.umich.edu/~aprakash/papers/undo-tochi94.pdf
|
||||
http://web.eecs.umich.edu/~aprakash/papers/undo-tochi94.pdf
|
||||
Undoing Actions in Collaborative Work: Framework and Experience
|
||||
https://www.eecs.umich.edu/techreports/cse/94/CSE-TR-196-94.pdf
|
||||
Implementing a Selective Undo Framework in Python
|
||||
http://www.python.org/workshops/1997-10/proceedings/zukowski.html
|
||||
https://legacy.python.org/workshops/1997-10/proceedings/zukowski.html
|
||||
|
||||
|
||||
|
||||
@ -1 +1 @@
|
||||
Subproject commit c511065cec69629c0ff4148f4d4020e3323637de
|
||||
Subproject commit ceb5befd1cc2bb398bae159e9e4e7c44d86fc6c2
|
||||
@ -27,8 +27,8 @@ from gaphor.diagram.support import represents
|
||||
class ClassItem(ElementPresentation, Classified):
|
||||
"""This item visualizes a Class instance.
|
||||
|
||||
A ClassItem contains two compartments: one for
|
||||
attributes and one for operations.
|
||||
A ClassItem contains two compartments: one for attributes and one for
|
||||
operations.
|
||||
"""
|
||||
|
||||
__style__ = {
|
||||
|
||||
@ -10,6 +10,6 @@ references.
|
||||
As said, the binary parts have to be present on the system. The rest is done
|
||||
with [pip][2] in a [venv][3].
|
||||
|
||||
[1]: http://github.com/amolenaar/homebrew
|
||||
[1]: https://github.com/amolenaar/homebrew
|
||||
[2]: https://pypi.org/project/pip/
|
||||
[3]: https://docs.python.org/3/library/venv.html
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user