kozorizki/gaphor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanup references to the manual and update links

Browse Source 
Signed-off-by: Dan Yeaw <dan@yeaw.me>
This commit is contained in:
Dan Yeaw 2019-11-10 22:15:30 -05:00
parent 5d44707667
commit 912949178f
No known key found for this signature in database
GPG Key ID: 77A923EF537B61A4
7 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -113,7 +113,8 @@ mingw-w64-x86-64-python3-setuptools mingw-w64-x86-64-python3-zope.interface \
mingw-w64-x86-64-python3-coverage mingw-w64-x86-64-python3-pytest
```
[Clone the repository](https://help.github.com/en/articles/cloning-a-repository).
[Clone the
repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
```bash
$ cd gaphor
$ source ./venv
@ -148,7 +149,8 @@ and cairo build dependencies, for example, in Ubuntu execute:
$ sudo apt-get install -y python3-dev python3-gi python3-gi-cairo
gir1.2-gtk-3.0 libgirepository1.0-dev libcairo2-dev
```
[Clone the repository](https://help.github.com/en/articles/cloning-a-repository).
[Clone the
repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
```
$ cd gaphor
@ -163,7 +165,8 @@ To setup a development environment with macOS:
```bash
$ brew install python3 gobject-introspection gtk+3
```
[Clone the repository](https://help.github.com/en/articles/cloning-a-repository).
[Clone the
repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
```
$ cd gaphor
$ source ./venv

6
docs/event_system.md
View File

@ -1,11 +1,11 @@
# Event system
# Event System
The Generic library provides the `generic.event` module which is used to
implement the event system in Gaphor. This event system in Gaphor provides an
API to *subscribe* to events and to then *handle* those events so previously
subscribed *handlers* are being executed.
## Basic usage
## Basic Usage
In order to specify the event types we want to use in Gaphor, `generic.event`
dispatches events to corresponding handlers by inspecting the events' types. We
@ -33,7 +33,7 @@ its argument, in order to execute the subscribed handler to print the comment:
handle(CommentAdded(167, "Hello!")) # prints `Got new comment: Hello!`
## API reference
## API Reference
```eval_rst
.. autoclass:: gaphor.misc.generic.event.Manager

19
docs/index.rst
View File

@ -1,19 +1,20 @@
Welcome to Gaphor's documentation!
The Gaphor Technical Documentation
==================================
Some highlights of the documentation:
This documentation is aimed at those who would be interested in making
contributions to Gaphor. For tutorials and how-to information, please visit the
`Gaphor Website <https://gaphor.org>`_.
* 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.
In the future, we would like to split the documentation in to sections that
focus on *explanation** (understanding-oriented) and **reference**
(information-oriented). For now, this information is all together.
If you're into writing plug-ins for Gaphor you should have a look at our
fabulous `Hello world <http://github.com/gaphor/gaphor.plugins.helloworld>`_
fabulous `Hello world <https://github.com/gaphor/gaphor.plugins.helloworld>`_
plug-in.
.. toctree::
:maxdepth: 2
manual/index
Platforms
---------
Setting up a development environment, and packaging Gaphor on different
platforms:

2
docs/linux.md
View File

@ -29,7 +29,7 @@ gir1.2-gtk-3.0 libgirepository1.0-dev libcairo2-dev
```
[Clone the
repository](https://help.github.com/en/articles/cloning-a-repository).
repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
```bash
$ cd gaphor

3
docs/macos.md
View File

@ -8,7 +8,8 @@ To setup a development environment with macOS:
```bash
$ brew install python3 gobject-introspection gtk+3
```
[Clone the repository](https://help.github.com/en/articles/cloning-a-repository).
[Clone the
repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
```
$ cd gaphor
$ source ./venv

3
docs/services.md
View File

@ -42,4 +42,5 @@ Currently a plugin is defined by an XML file. This will change as
plugins should be distributable as Eggs too. A plugin will contain user
interface information along with its service definition.
See also: [Writing plugins](manual/plugins.md)
For more information, please also see our how-to on [writing a
plugin](https://gaphor.org/pages/writing-a-plugin.html)

5
docs/windows.md
View File

@ -17,7 +17,8 @@ mingw-w64-x86-64-python3-setuptools mingw-w64-x86-64-python3-zope.interface \
mingw-w64-x86-64-python3-coverage mingw-w64-x86-64-python3-pytest
```
[Clone the repository](https://help.github.com/en/articles/cloning-a-repository).
[Clone the
repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
```bash
$ cd gaphor
$ source venv
@ -30,7 +31,7 @@ In order to create an exe installation package for Windows, we utilize
[PyInstaller](https://pyinstaller.org) which analyzes Gaphor to find all the
dependencies and bundle them in to a single folder. We then use a custom bash
script that creates a Windows installer using
[NSIS](https://nsis.sourceforge.io) and a portable installer using
[NSIS](https://nsis.sourceforge.io/Main_Page) and a portable installer using
[7-Zip](https://www.7-zip.org).
1. Follow the instructions for settings up a development environment above