diff options
Diffstat (limited to 'js/blotbotboot/node_modules/irc/docs')
| -rw-r--r-- | js/blotbotboot/node_modules/irc/docs/API.rst | 548 | ||||
| -rw-r--r-- | js/blotbotboot/node_modules/irc/docs/Makefile | 130 | ||||
| -rw-r--r-- | js/blotbotboot/node_modules/irc/docs/conf.py | 216 | ||||
| -rw-r--r-- | js/blotbotboot/node_modules/irc/docs/index.rst | 13 | ||||
| -rw-r--r-- | js/blotbotboot/node_modules/irc/docs/make.bat | 170 |
5 files changed, 0 insertions, 1077 deletions
diff --git a/js/blotbotboot/node_modules/irc/docs/API.rst b/js/blotbotboot/node_modules/irc/docs/API.rst deleted file mode 100644 index 5194adb..0000000 --- a/js/blotbotboot/node_modules/irc/docs/API.rst +++ /dev/null @@ -1,548 +0,0 @@ -API -=== - -This library provides IRC client functionality - -Client ----------- - -.. js:function:: irc.Client(server, nick [, options]) - - This object is the base of everything, it represents a single nick connected to - a single IRC server. - - The first two arguments are the server to connect to, and the nickname to - attempt to use. The third optional argument is an options object with default - values:: - - { - userName: 'nodebot', - realName: 'nodeJS IRC client', - port: 6667, - localAddress: null, - debug: false, - showErrors: false, - autoRejoin: false, - autoConnect: true, - channels: [], - secure: false, - selfSigned: false, - certExpired: false, - floodProtection: false, - floodProtectionDelay: 1000, - sasl: false, - retryCount: 0, - retryDelay: 2000, - stripColors: false, - channelPrefixes: "&#", - messageSplit: 512, - encoding: '' - } - - `secure` (SSL connection) can be a true value or an object (the kind of object - returned from `crypto.createCredentials()`) specifying cert etc for validation. - If you set `selfSigned` to true SSL accepts certificates from a non trusted CA. - If you set `certExpired` to true, the bot connects even if the ssl cert has expired. - - `localAddress` is the address to bind to when connecting. - - `floodProtection` queues all your messages and slowly unpacks it to make sure - that we won't get kicked out because for Excess Flood. You can also use - `Client.activateFloodProtection()` to activate flood protection after - instantiating the client. - - `floodProtectionDelay` sets the amount of time that the client will wait - between sending subsequent messages when `floodProtection` is enabled. - - Set `sasl` to true to enable SASL support. You'll also want to set `nick`, - `userName`, and `password` for authentication. - - `stripColors` removes mirc colors (0x03 followed by one or two ascii - numbers for foreground,background) and ircII "effect" codes (0x02 - bold, 0x1f underline, 0x16 reverse, 0x0f reset) from the entire - message before parsing it and passing it along. - - `messageSplit` will split up large messages sent with the `say` method - into multiple messages of length fewer than `messageSplit` characters. - - With `encoding` you can set IRC bot to convert all messages to specified character set. If you don't want to use - this just leave value blank or false. Example values are UTF-8, ISO-8859-15, etc. - - Setting `debug` to true will emit timestamped messages to the console - using `util.log` when certain events are fired. - - `autoRejoin` has the client rejoin channels after being kicked. - - Setting `autoConnect` to false prevents the Client from connecting on - instantiation. You will need to call `connect()` on the client instance:: - - var client = new irc.Client({ autoConnect: false, ... }); - client.connect(); - - `retryCount` is the number of times the client will try to automatically reconnect when disconnected. It defaults to 0. - - `retryDelay` is the number of milliseconds to wait before retying to automatically reconnect when disconnected. It defaults to 2000. - -.. js:function:: Client.send(command, arg1, arg2, ...) - - Sends a raw message to the server; generally speaking, it's best not to use - this method unless you know what you're doing. Instead, use one of the - methods below. - -.. js:function:: Client.join(channel, callback) - - Joins the specified channel. - - :param string channel: Channel to join - :param function callback: Callback to automatically subscribed to the - `join#channel` event, but removed after the first invocation. `channel` - supports multiple JOIN arguments as a space separated string (similar to - the IRC protocol). - -.. js:function:: Client.part(channel, [message], callback) - - Parts the specified channel. - - :param string channel: Channel to part - :param string message: Optional message to send upon leaving the channel - :param function callback: Callback to automatically subscribed to the - `part#channel` event, but removed after the first invocation. - -.. js:function:: Client.say(target, message) - - Sends a message to the specified target. - - :param string target: is either a nickname, or a channel. - :param string message: the message to send to the target. - -.. js:function:: Client.ctcp(target, type, text) - - Sends a CTCP message to the specified target. - - :param string target: is either a nickname, or a channel. - :param string type: the type of the CTCP message. Specify "privmsg" for a - PRIVMSG, and anything else for a NOTICE. - :param string text: the CTCP message to send. - -.. js:function:: Client.action(target, message) - - Sends an action to the specified target. - -.. js:function:: Client.notice(target, message) - - Sends a notice to the specified target. - - :param string target: is either a nickname, or a channel. - :param string message: the message to send as a notice to the target. - -.. js:function:: Client.whois(nick, callback) - - Request a whois for the specified `nick`. - - :param string nick: is a nickname - :param function callback: Callback to fire when the server has finished - generating the whois information and is passed exactly the same - information as a `whois` event described above. - -.. js:function:: Client.list([arg1, arg2, ...]) - - Request a channel listing from the server. The arguments for this method are - fairly server specific, this method just passes them through exactly as - specified. - - Responses from the server are available via the `channellist_start`, - `channellist_item`, and `channellist` events. - -.. js:function:: Client.connect([retryCount [, callback]]) - - Connects to the server. Used when `autoConnect` in the options is set to - false. If `retryCount` is a function it will be treated as the `callback` - (i.e. both arguments to this function are optional). - - :param integer retryCount: Optional number of times to attempt reconnection - :param function callback: Optional callback - -.. js:function:: Client.disconnect([message [, callback]]) - - Disconnects from the IRC server. If `message` is a function it will be - treated as the `callback` (i.e. both arguments to this function are - optional). - - :param string message: Optional message to send when disconnecting. - :param function callback: Optional callback - -.. js:function:: Client.activateFloodProtection([interval]) - - Activates flood protection "after the fact". You can also use - `floodProtection` while instantiating the Client to enable flood - protection, and `floodProtectionDelay` to set the default message - interval. - - :param integer interval: Optional configuration for amount of time - to wait between messages. Takes value from client configuration - if unspecified. - -Events ------- - -`irc.Client` instances are EventEmitters with the following events: - - -.. js:data:: 'registered' - - `function (message) { }` - - Emitted when the server sends the initial 001 line, indicating you've connected - to the server. See the `raw` event for details on the `message` object. - -.. js:data:: 'motd' - - `function (motd) { }` - - Emitted when the server sends the message of the day to clients. - -.. js:data:: 'names' - - `function (channel, nicks) { }` - - Emitted when the server sends a list of nicks for a channel (which happens - immediately after joining and on request. The nicks object passed to the - callback is keyed by nick names, and has values '', '+', or '@' depending on the - level of that nick in the channel. - -.. js:data:: 'names#channel' - - `function (nicks) { }` - - As per 'names' event but only emits for the subscribed channel. - -.. js:data:: 'topic' - - `function (channel, topic, nick, message) { }` - - Emitted when the server sends the channel topic on joining a channel, or when a - user changes the topic on a channel. See the `raw` event for details on the - `message` object. - -.. js:data:: 'join' - - `function (channel, nick, message) { }` - - Emitted when a user joins a channel (including when the client itself joins a - channel). See the `raw` event for details on the `message` object. - -.. js:data:: 'join#channel' - - `function (nick, message) { }` - - As per 'join' event but only emits for the subscribed channel. - See the `raw` event for details on the `message` object. - -.. js:data:: 'part' - - `function (channel, nick, reason, message) { }` - - Emitted when a user parts a channel (including when the client itself parts a - channel). See the `raw` event for details on the `message` object. - -.. js:data:: 'part#channel' - - `function (nick, reason, message) { }` - - As per 'part' event but only emits for the subscribed channel. - See the `raw` event for details on the `message` object. - -.. js:data:: 'quit' - - `function (nick, reason, channels, message) { }` - - Emitted when a user disconnects from the IRC, leaving the specified array of - channels. See the `raw` event for details on the `message` object. - -.. js:data:: 'kick' - - `function (channel, nick, by, reason, message) { }` - - Emitted when a user is kicked from a channel. See the `raw` event for details - on the `message` object. - -.. js:data:: 'kick#channel' - - `function (nick, by, reason, message) { }` - - As per 'kick' event but only emits for the subscribed channel. - See the `raw` event for details on the `message` object. - -.. js:data:: 'kill' - - `function (nick, reason, channels, message) { }` - - Emitted when a user is killed from the IRC server. - `channels` is an array of channels the killed user was in which - are known to the client. - See the `raw` event for details on the `message` object. - -.. js:data:: 'message' - - `function (nick, to, text, message) { }` - - Emitted when a message is sent. `to` can be either a nick (which is most likely - this clients nick and means a private message), or a channel (which means a - message to that channel). See the `raw` event for details on the `message` object. - -.. js:data:: 'message#' - - `function (nick, to, text, message) { }` - - Emitted when a message is sent to any channel (i.e. exactly the same as the - `message` event but excluding private messages. - See the `raw` event for details on the `message` object. - -.. js:data:: 'message#channel' - - `function (nick, text, message) { }` - - As per 'message' event but only emits for the subscribed channel. - See the `raw` event for details on the `message` object. - -.. js:data:: 'selfMessage' - - `function (to, text) { }` - - Emitted when a message is sent from the client. `to` is who the message was - sent to. It can be either a nick (which most likely means a private message), - or a channel (which means a message to that channel). - -.. js:data:: 'notice' - - `function (nick, to, text, message) { }` - - Emitted when a notice is sent. `to` can be either a nick (which is most likely - this clients nick and means a private message), or a channel (which means a - message to that channel). `nick` is either the senders nick or `null` which - means that the notice comes from the server. See the `raw` event for details - on the `message` object. - -.. js:data:: 'ping' - - `function (server) { }` - - Emitted when a server PINGs the client. The client will automatically send a - PONG request just before this is emitted. - -.. js:data:: 'pm' - - `function (nick, text, message) { }` - - As per 'message' event but only emits when the message is direct to the client. - See the `raw` event for details on the `message` object. - -.. js:data:: 'ctcp' - - `function (from, to, text, type, message) { }` - - Emitted when a CTCP notice or privmsg was received (`type` is either `'notice'` - or `'privmsg'`). See the `raw` event for details on the `message` object. - -.. js:data:: 'ctcp-notice' - - `function (from, to, text, message) { }` - - Emitted when a CTCP notice was received. - See the `raw` event for details on the `message` object. - -.. js:data:: 'ctcp-privmsg' - - `function (from, to, text, message) { }` - - Emitted when a CTCP privmsg was received. - See the `raw` event for details on the `message` object. - -.. js:data:: 'ctcp-version' - - `function (from, to, message) { }` - - Emitted when a CTCP VERSION request was received. - See the `raw` event for details on the `message` object. - -.. js:data:: 'nick' - - `function (oldnick, newnick, channels, message) { }` - - Emitted when a user changes nick along with the channels the user is in. - See the `raw` event for details on the `message` object. - -.. js:data:: 'invite' - - `function (channel, from, message) { }` - - Emitted when the client receives an `/invite`. See the `raw` event for details - on the `message` object. - -.. js:data:: '+mode' - - `function (channel, by, mode, argument, message) { }` - - Emitted when a mode is added to a user or channel. `channel` is the channel - which the mode is being set on/in. `by` is the user setting the mode. `mode` - is the single character mode identifier. If the mode is being set on a user, - `argument` is the nick of the user. If the mode is being set on a channel, - `argument` is the argument to the mode. If a channel mode doesn't have any - arguments, `argument` will be 'undefined'. See the `raw` event for details - on the `message` object. - -.. js:data:: '-mode' - - `function (channel, by, mode, argument, message) { }` - - Emitted when a mode is removed from a user or channel. `channel` is the channel - which the mode is being set on/in. `by` is the user setting the mode. `mode` - is the single character mode identifier. If the mode is being set on a user, - `argument` is the nick of the user. If the mode is being set on a channel, - `argument` is the argument to the mode. If a channel mode doesn't have any - arguments, `argument` will be 'undefined'. See the `raw` event for details - on the `message` object. - -.. js:data:: 'whois' - - `function (info) { }` - - Emitted whenever the server finishes outputting a WHOIS response. The - information should look something like:: - - { - nick: "Ned", - user: "martyn", - host: "10.0.0.18", - realname: "Unknown", - channels: ["@#purpledishwashers", "#blah", "#mmmmbacon"], - server: "*.dollyfish.net.nz", - serverinfo: "The Dollyfish Underworld", - operator: "is an IRC Operator" - } - -.. js:data:: 'channellist_start' - - `function () {}` - - Emitted whenever the server starts a new channel listing - -.. js:data:: 'channellist_item' - - `function (channel_info) {}` - - Emitted for each channel the server returns. The channel_info object - contains keys 'name', 'users' (number of users on the channel), and 'topic'. - -.. js:data:: 'channellist' - - `function (channel_list) {}` - - Emitted when the server has finished returning a channel list. The - channel_list array is simply a list of the objects that were returned in the - intervening `channellist_item` events. - - This data is also available via the Client.channellist property after this - event has fired. - -.. js:data:: 'raw' - - `function (message) { }` - - Emitted when ever the client receives a "message" from the server. A message is - basically a single line of data from the server, but the parameter to the - callback has already been parsed and contains:: - - message = { - prefix: "The prefix for the message (optional)", - nick: "The nickname portion of the prefix (optional)", - user: "The username portion of the prefix (optional)", - host: "The hostname portion of the prefix (optional)", - server: "The servername (if the prefix was a servername)", - rawCommand: "The command exactly as sent from the server", - command: "Human readable version of the command", - commandType: "normal, error, or reply", - args: ['arguments', 'to', 'the', 'command'], - } - - You can read more about the IRC protocol by reading `RFC 1459 - <http://www.ietf.org/rfc/rfc1459.txt>`_ - -.. js:data:: 'error' - - `function (message) { }` - - Emitted when ever the server responds with an error-type message. The message - parameter is exactly as in the 'raw' event. - -.. js:data:: 'action' - - `function (from, to, text, message) { }` - - Emitted whenever a user performs an action (e.g. `/me waves`). - The message parameter is exactly as in the 'raw' event. - -Colors ------- - -.. js:function:: irc.colors.wrap(color, text [, reset_color]) - - Takes a color by name, text, and optionally what color to return. - - :param string color: the name of the color as a string - :param string text: the text you want colorized - :param string reset_color: the name of the color you want set after the text (defaults to 'reset') - -.. js:data:: irc.colors.codes - - This contains the set of colors available and a function to wrap text in a - color. - - The following color choices are available: - - { - white: '\u000300', - black: '\u000301', - dark_blue: '\u000302', - dark_green: '\u000303', - light_red: '\u000304', - dark_red: '\u000305', - magenta: '\u000306', - orange: '\u000307', - yellow: '\u000308', - light_green: '\u000309', - cyan: '\u000310', - light_cyan: '\u000311', - light_blue: '\u000312', - light_magenta: '\u000313', - gray: '\u000314', - light_gray: '\u000315', - reset: '\u000f', - } - -Internal ------- - -.. js:data:: Client.conn - - Socket to the server. Rarely, if ever needed. Use `Client.send` instead. - -.. js:data:: Client.chans - - Channels joined. Includes channel modes, user list, and topic information. Only updated *after* the server recognizes the join. - -.. js:data:: Client.nick - - The current nick of the client. Updated if the nick changes (e.g. nick collision when connecting to a server). - -.. js:function:: client._whoisData - - Buffer of whois data as whois is sent over multiple lines. - -.. js:function:: client._addWhoisData - - Self-explanatory. - -.. js:function:: client._clearWhoisData - - Self-explanatory. diff --git a/js/blotbotboot/node_modules/irc/docs/Makefile b/js/blotbotboot/node_modules/irc/docs/Makefile deleted file mode 100644 index a06411c..0000000 --- a/js/blotbotboot/node_modules/irc/docs/Makefile +++ /dev/null @@ -1,130 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -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) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -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 " 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/node-irc.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/node-irc.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/node-irc" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/node-irc" - @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." - -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." diff --git a/js/blotbotboot/node_modules/irc/docs/conf.py b/js/blotbotboot/node_modules/irc/docs/conf.py deleted file mode 100644 index 4f7e06b..0000000 --- a/js/blotbotboot/node_modules/irc/docs/conf.py +++ /dev/null @@ -1,216 +0,0 @@ -# -*- coding: utf-8 -*- -# -# node-irc documentation build configuration file, created by -# sphinx-quickstart on Sat Oct 1 00:02:31 2011. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'node-irc' -copyright = u'2011, Martyn Smith' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '2.1' -# The full version, including alpha/beta/rc tags. -release = '2.1' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'node-ircdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'node-irc.tex', u'node-irc Documentation', - u'Martyn Smith', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'node-irc', u'node-irc Documentation', - [u'Martyn Smith'], 1) -] diff --git a/js/blotbotboot/node_modules/irc/docs/index.rst b/js/blotbotboot/node_modules/irc/docs/index.rst deleted file mode 100644 index d35bc0f..0000000 --- a/js/blotbotboot/node_modules/irc/docs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -Welcome to node-irc's documentation! -==================================== - -.. include:: ../README.rst - -More detailed docs: -------------------- - -.. toctree:: - :maxdepth: 2 - - API - diff --git a/js/blotbotboot/node_modules/irc/docs/make.bat b/js/blotbotboot/node_modules/irc/docs/make.bat deleted file mode 100644 index dc41ed1..0000000 --- a/js/blotbotboot/node_modules/irc/docs/make.bat +++ /dev/null @@ -1,170 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :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. text to make text files - echo. man to make manual pages - echo. changes to make an overview over 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 - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\node-irc.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\node-irc.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -:end |