GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-11-27 21:19:31 +01:00
Code Issues Projects Releases Wiki Activity

docs/t: use rawgit links to serve HTML

Browse Source
This commit is contained in:
James Lu 2016-03-11 23:18:14 -08:00
parent 506ae011a4
commit 0dd8b80a21
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/technical/pmodule-spec.md
View File

@ -2,7 +2,7 @@
In PyLink, each protocol module is a single file consisting of a protocol class, and a global `Class` attribute that is set equal to it (e.g. `Class = InspIRCdProtocol`). These classes should be based off of either [`classes.Protocol`](https://github.com/GLolol/PyLink/blob/e4fb64aebaf542122c70a8f3a49061386a00b0ca/classes.py#L532), a boilerplate class that only defines a few basic things, or [`ts6_common.TS6BaseProtocol`](https://github.com/GLolol/PyLink/blob/0.5.0-dev/protocols/ts6_common.py), which includes elements of the TS6 protocol that are shared by the InspIRCd, UnrealIRCd, and TS6 protocols. IRC objects load protocol modules by creating an instance of its main class, and sends it commands accordingly. In PyLink, each protocol module is a single file consisting of a protocol class, and a global `Class` attribute that is set equal to it (e.g. `Class = InspIRCdProtocol`). These classes should be based off of either [`classes.Protocol`](https://github.com/GLolol/PyLink/blob/e4fb64aebaf542122c70a8f3a49061386a00b0ca/classes.py#L532), a boilerplate class that only defines a few basic things, or [`ts6_common.TS6BaseProtocol`](https://github.com/GLolol/PyLink/blob/0.5.0-dev/protocols/ts6_common.py), which includes elements of the TS6 protocol that are shared by the InspIRCd, UnrealIRCd, and TS6 protocols. IRC objects load protocol modules by creating an instance of its main class, and sends it commands accordingly.
See also: [autogen/inspircd.html](autogen/inspircd.html) for auto-generated documentation the InspIRCd protocol module. See also: [autogen/inspircd.html](https://cdn.rawgit.com/GLolol/PyLink/506ae011a4a13531a66272573441f6f6bf5471f6/docs/technical/autogen/inspircd.html) for auto-generated documentation the InspIRCd protocol module.
## Tasks ## Tasks

2
docs/technical/using-utils.md
View File

@ -1 +1 @@
See [autogen/utils.html](autogen/utils.html) for auto-generated documentation for the utils module. See [autogen/utils.html](https://cdn.rawgit.com/GLolol/PyLink/506ae011a4a13531a66272573441f6f6bf5471f6/docs/technical/autogen/utils.html) for auto-generated documentation for the utils module.