]> jfr.im git - irc/hexchat/documentation.git/log
irc/hexchat/documentation.git
9 months agoRemove obsolete links from tips.rst master origin/HEAD origin/master
Lorenzo Ancora [Fri, 4 Aug 2023 16:29:18 +0000 (18:29 +0200)] 
Remove obsolete links from tips.rst

Remove potentially dangerous links and dangling links; make sure the documentation does not depend on a single IRC network.

12 months agoFAQ: Document Safe Mode
Patrick [Thu, 11 May 2023 20:01:06 +0000 (15:01 -0500)] 
FAQ: Document Safe Mode

Closes hexchat/hexchat#2784

12 months agoscript_dbus: fix broken link for python example
bretello [Tue, 9 May 2023 13:25:08 +0000 (15:25 +0200)] 
script_dbus: fix broken link for python example

19 months agoUpdate faq.rst
Patrick [Tue, 4 Oct 2022 16:22:18 +0000 (11:22 -0500)] 
Update faq.rst

19 months agoUpdate faq.rst
Patrick [Tue, 4 Oct 2022 16:21:49 +0000 (11:21 -0500)] 
Update faq.rst

19 months agoUpdate faq.rst
Patrick [Tue, 4 Oct 2022 16:14:36 +0000 (11:14 -0500)] 
Update faq.rst

19 months agoUpdate faq.rst
Patrick [Tue, 4 Oct 2022 16:12:39 +0000 (11:12 -0500)] 
Update faq.rst

22 months agoUpdate appearance.rst
Patrick [Sat, 9 Jul 2022 16:23:57 +0000 (11:23 -0500)] 
Update appearance.rst

22 months agoUpdate appearance.rst
Patrick [Mon, 27 Jun 2022 15:59:44 +0000 (10:59 -0500)] 
Update appearance.rst

22 months agoUpdate appearance.rst
Patrick [Mon, 27 Jun 2022 15:58:57 +0000 (10:58 -0500)] 
Update appearance.rst

2 years agofix spelling of "theme"
vulpine [Thu, 14 Apr 2022 20:48:38 +0000 (16:48 -0400)] 
fix spelling of "theme"

2 years agoUpdate changelog.rst
Patrick [Sat, 12 Feb 2022 19:11:02 +0000 (13:11 -0600)] 
Update changelog.rst

2 years agoMeson Build Option: Theme Manager
Rory Dudley [Tue, 1 Feb 2022 23:58:18 +0000 (16:58 -0700)] 
Meson Build Option: Theme Manager

Update the docs with the correct meson option to build HexChat's theme
manager alongside HexChat ('with-theme-manager' -> 'theme-manager').  As
per meson options:
https://github.com/hexchat/hexchat/blob/7cff05c7ac4efe30a34f7f1bc5d5aa7463cb4f16/meson_options.txt#L8.

2 years agoUpdate faq.rst
Patrick [Thu, 2 Dec 2021 12:20:05 +0000 (06:20 -0600)] 
Update faq.rst

2 years agoSlight clarification in Exec plugin docs
Patrick [Fri, 12 Nov 2021 17:16:13 +0000 (11:16 -0600)] 
Slight clarification in Exec plugin docs

Closes hexchat/2651

2 years agoUpdate conf.py
Patrick [Sun, 7 Nov 2021 16:21:29 +0000 (10:21 -0600)] 
Update conf.py

2 years agoUpdate script_python.rst
Patrick [Sat, 6 Nov 2021 16:26:41 +0000 (11:26 -0500)] 
Update script_python.rst

2 years agoUpdate building.rst
Patrick [Thu, 7 Oct 2021 19:06:22 +0000 (14:06 -0500)] 
Update building.rst

2 years agoUpdate changelog.rst
Patrick [Sat, 2 Oct 2021 14:51:04 +0000 (09:51 -0500)] 
Update changelog.rst

2 years agoUpdate changelog
Patrick Griffis [Fri, 1 Oct 2021 19:54:42 +0000 (14:54 -0500)] 
Update changelog

2 years agoUpdate Visual Studio version
Patrick [Mon, 24 May 2021 02:30:39 +0000 (21:30 -0500)] 
Update Visual Studio version

2 years agoUpdate IRC channel
Patrick [Mon, 24 May 2021 02:25:28 +0000 (21:25 -0500)] 
Update IRC channel

3 years agoFix new warnings from sphinx-build v3.3+
Howard Johnson [Thu, 31 Dec 2020 04:22:58 +0000 (18:22 -1000)] 
Fix new warnings from sphinx-build v3.3+

PROBLEM --------------------------------------------------------------
  Upgraded from sphinx-build v2 to v3.3.1.

  Then running:

    mkdir x                                             && cd x
    git clone https://github.com/hexchat/documentation  && cd documentation
    make clean && make html           # To build the html output files

  outputs a bunch of new WARNING messages, including these:

    $ make clean && make html
    sphinx-build -b html -d _build/doctrees   . _build/html
    Running Sphinx v3.3.1
    making output directory... done
    ...

    /home/howard/git-repos/hexchat/documentation/plugins.rst:658: WARNING: Unparseable C cross-reference: 'hexchat_event_attrs *'
    Invalid C declaration: Expected end of definition. [error at 20]    <-- fixes these 3 warnings
      hexchat_event_attrs *
      --------------------^
    /home/howard/git-repos/hexchat/documentation/plugins.rst:1030: WARNING: Unparseable C cross-reference: 'hexchat_event_attrs *'
    Invalid C declaration: Expected end of definition. [error at 20]
      hexchat_event_attrs *
      --------------------^
    /home/howard/git-repos/hexchat/documentation/plugins.rst:1080: WARNING: Unparseable C cross-reference: 'hexchat_event_attrs *'
    Invalid C declaration: Expected end of definition. [error at 20]
      hexchat_event_attrs *
      --------------------^

SOLUTION --------------------------------------------------------------
  First note plugins.rst line 4:

    .. default-domain:: c     # So :func: is :c:func:

  From : https://bugs.python.org/issue40204 I found that in sphinx-build:

    "The C domain has been rewritten, with additional directives and roles.
    The existing ones are now more strict, resulting in new warnings."

  The first warning actually comes from line 659 which is a continuation of line 658.

  It seems that type does not now allow a pointer symbol (*) appended to it.

  Docs:  https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

  Note
    To rerun `make html` again, first `touch plugins.rst`, or run make clean.

OTHER --------------------------------------------------------------
  I'm new to open source contributing. Appreciate any help.
  hwj@BridgeportContractor.com

3 years agovar:: to macro:: fixes sphinx-build v3.3+ warning
Howard Johnson [Thu, 31 Dec 2020 04:21:49 +0000 (18:21 -1000)] 
var:: to macro:: fixes sphinx-build v3.3+ warning

PROBLEM --------------------------------------------------------------
  Upgraded from sphinx-build v2 to v3.3.1.

  Then running:

    mkdir x                                             && cd x
    git clone https://github.com/hexchat/documentation  && cd documentation
    make clean && make html           # To build the html output files

  outputs a bunch of new WARNING messages, including these:

    $ make clean && make html
    sphinx-build -b html -d _build/doctrees   . _build/html
    Running Sphinx v3.3.1
    ...
    /home/howard/git-repos/hexchat/documentation/plugins.rst:579: WARNING: Error in declarator or parameters
    Invalid C declaration: Expected identifier in nested name. [error at 19]    <-- fixes these 12 warnings
      HEXCHAT_PRI_HIGHEST
      -------------------^

  (Plus 11 more warnings like this.)

SOLUTION --------------------------------------------------------------
  First note plugins.rst line 4:

    .. default-domain:: c     # this sets default domain to :c:*

  Next, https://bugs.python.org/issue40204 reports:

    "The C domain has been rewritten, with additional directives and roles.
    The existing ones are now more strict, resulting in new warnings."

    Correct usage for `.. var::` and `.. macro::` are documented here:
      https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

  For comparision current hexchat built docs is at:
https://hexchat.readthedocs.io/en/latest/plugins.html#c.HEXCHAT_PRI_HIGHEST

  Note
    To rerun `make html` again, first `touch plugins.rst` or run `make clean`.

OTHER --------------------------------------------------------------
  I'm new to open source contributing. Appreciate any help.
  hwj@BridgeportContractor.com

3 years agoLet html_add_permalinks now use default value
Howard Johnson [Thu, 31 Dec 2020 02:19:59 +0000 (16:19 -1000)] 
Let html_add_permalinks now use default value

PROBLEM --------------------------------------------------------------
  Upgraded from sphinx-build v2 to v3.3.1.

  Then running:

    mkdir x                                             && cd x
    git clone https://github.com/hexchat/documentation  && cd documentation
    make clean && make html           # To build the html output files

  outputs a bunch of new WARNING messages, including this one:

    $ make clean && make html
    sphinx-build -b html -d _build/doctrees   . _build/html
    Running Sphinx v3.3.1
    making output directory... done
    WARNING: The config value `html_add_permalinks' has type `bool', defaults to `str'.  <-- fixes this warning
    ...

SOLUTION --------------------------------------------------------------
  There is now no need for that line, so remove it.
    Ref:  https://jira.hyperledger.org/browse/FAB-9206h

  Docs: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_add_permalinks

OTHER --------------------------------------------------------------
  I'm new to open source contributing. Appreciate any help.
  hwj@BridgeportContractor.com

3 years agoFix 'favicon.ico' does not exist WARNING
Howard Johnson [Thu, 31 Dec 2020 02:16:18 +0000 (16:16 -1000)] 
Fix 'favicon.ico' does not exist WARNING

PROBLEM --------------------------------------------------------------
  Upgraded from sphinx-build v2 to v3.3.1.

  Then running:

    mkdir x                                             && cd x
    git clone https://github.com/hexchat/documentation  && cd documentation
    make clean && make html           # To build the html output files

  outputs a bunch of new WARNING messages, including this one:

    $ make clean && make html
    sphinx-build -b html -d _build/doctrees   . _build/html
    Running Sphinx v3.3.1
    making output directory... done
    WARNING: favicon file 'favicon.ico' does not exist              <-- fixes this warning
    ...

SOLUTION:  --------------------------------------------------------------
  Added path to favicon.ico

OTHER --------------------------------------------------------------
  I'm new to open source contributing. Appreciate any help.
  hwj@BridgeportContractor.com

3 years agoWork around for missing Show/Edit github link
Howard Johnson [Thu, 31 Dec 2020 02:13:31 +0000 (16:13 -1000)] 
Work around for missing Show/Edit github link

PROBLEM --------------------------------------------------------------
  Aparently there used to be a link to the documentation, as it said:

"For simple edits of the documentation just go to the page and
click *Show/Edit on Github* on the left side, fork the repo,
edit it, and submit a pull request."

  But, if you go to a page like these:
    https://hexchat.readthedocs.io/en/latest/getting_started.html   OR
    https://hexchat.readthedocs.io/en/latest/helping.html

  There are no links to Show or Edit on Github.

SOLUTION --------------------------------------------------------------
  While you might be able to guess the documenation URL, this commit
  adds an explicit link to the github helping page that links to the
  hexchat documentation.

  (Hopefully the Show/Edit link can be fixed, but I don't know how to fix it.)
  Here is a hint if you can figure it out:

    https://gist.github.com/mgedmin/6052926

OTHER --------------------------------------------------------------
  I'm new to open source contributing. Appreciate any help.
  hwj@BridgeportContractor.com

4 years agoBump version
Patrick [Tue, 10 Mar 2020 00:07:31 +0000 (17:07 -0700)] 
Bump version

4 years agoUse code blocks to retain formatting more consistently
Patrick [Mon, 3 Feb 2020 17:36:06 +0000 (09:36 -0800)] 
Use code blocks to retain formatting more consistently

4 years agoUpdate changelog.rst
Patrick [Sat, 21 Dec 2019 07:04:57 +0000 (23:04 -0800)] 
Update changelog.rst

4 years agoUpdate macOS instructions
Patrick [Sat, 7 Sep 2019 22:41:47 +0000 (15:41 -0700)] 
Update macOS instructions

Closes https://github.com/hexchat/hexchat/issues/2375

5 years agoUpdate tips.rst
Patrick [Wed, 1 May 2019 23:30:48 +0000 (16:30 -0700)] 
Update tips.rst

5 years agoAdd missing :command: markup to the exec addon
panicstations [Fri, 19 Apr 2019 09:17:04 +0000 (19:17 +1000)] 
Add missing :command: markup to the exec addon

5 years agofix space
quiddity-wp [Sat, 12 Jan 2019 20:25:55 +0000 (12:25 -0800)] 
fix space

5 years agoadd link to the repo of addons
quiddity-wp [Sat, 12 Jan 2019 20:24:00 +0000 (12:24 -0800)] 
add link to the repo of addons

5 years agoUpdate settings.rst
TingPing [Tue, 27 Nov 2018 20:26:52 +0000 (15:26 -0500)] 
Update settings.rst

5 years agoUpdate building.rst
TingPing [Sun, 11 Nov 2018 18:08:13 +0000 (13:08 -0500)] 
Update building.rst

5 years agoDocument signature of hexchat_plugin_deinit
Soni L [Fri, 2 Nov 2018 22:58:26 +0000 (19:58 -0300)] 
Document signature of hexchat_plugin_deinit

This was previously not documented anywhere.

5 years agoUpdate building.rst
TingPing [Sun, 21 Oct 2018 16:59:08 +0000 (12:59 -0400)] 
Update building.rst

5 years agoUpdate changelog
Patrick Griffis [Wed, 29 Aug 2018 22:40:14 +0000 (18:40 -0400)] 
Update changelog

5 years agoAdd changelog for 2.14.2
Patrick Griffis [Wed, 29 Aug 2018 21:39:21 +0000 (17:39 -0400)] 
Add changelog for 2.14.2

6 years agoUpdate Windows paths and IDP installer version
Parker Mauney [Sun, 18 Mar 2018 03:55:50 +0000 (20:55 -0700)] 
Update Windows paths and IDP installer version

Updated Windows paths in building.rst to match the default paths found in win32\hexchat.props.
Changed IDP link to point to most recent version (1.5.1).

6 years agoUpdate appearance.rst
TingPing [Wed, 14 Mar 2018 20:34:58 +0000 (16:34 -0400)] 
Update appearance.rst

6 years agoFix formatting
Patrick Griffis [Wed, 14 Mar 2018 03:52:15 +0000 (23:52 -0400)] 
Fix formatting

6 years agoUpdate changelog
Patrick Griffis [Wed, 14 Mar 2018 02:32:26 +0000 (22:32 -0400)] 
Update changelog

6 years agoUpdate changelog
Patrick Griffis [Sat, 10 Mar 2018 22:38:33 +0000 (17:38 -0500)] 
Update changelog

6 years agoUpdate building documentation
Patrick Griffis [Sat, 10 Mar 2018 02:23:36 +0000 (21:23 -0500)] 
Update building documentation

6 years agoUpdate settings.rst
TingPing [Thu, 14 Dec 2017 01:32:14 +0000 (20:32 -0500)] 
Update settings.rst

6 years agoUpdate faq.rst
TingPing [Thu, 23 Nov 2017 04:25:42 +0000 (23:25 -0500)] 
Update faq.rst

6 years agoUpdate faq.rst
TingPing [Thu, 23 Nov 2017 04:23:56 +0000 (23:23 -0500)] 
Update faq.rst

6 years agoUpdate tips.rst
TingPing [Thu, 16 Nov 2017 17:39:38 +0000 (12:39 -0500)] 
Update tips.rst

6 years agoAdd documentation for irc_reconnect_rejoin
Iwan Aucamp [Fri, 6 Oct 2017 23:53:32 +0000 (01:53 +0200)] 
Add documentation for irc_reconnect_rejoin

hexchat/hexchat#2069

6 years agoUpdate faq.rst
TingPing [Sun, 3 Sep 2017 12:20:47 +0000 (08:20 -0400)] 
Update faq.rst

6 years agoUpdate faq.rst
TingPing [Sun, 3 Sep 2017 12:20:05 +0000 (08:20 -0400)] 
Update faq.rst

6 years agoUpdate building.rst
TingPing [Wed, 14 Jun 2017 06:43:18 +0000 (02:43 -0400)] 
Update building.rst

7 years agoAdd Windows 10 dictionary getting.
sacarasc [Fri, 12 May 2017 22:42:12 +0000 (23:42 +0100)] 
Add Windows 10 dictionary getting.

7 years agoUpdate appearance.rst
TingPing [Tue, 14 Mar 2017 04:04:55 +0000 (00:04 -0400)] 
Update appearance.rst

7 years agoUpdate faq.rst
TingPing [Thu, 9 Mar 2017 02:13:13 +0000 (21:13 -0500)] 
Update faq.rst

7 years agoUpdate faq.rst
TingPing [Thu, 9 Mar 2017 02:11:10 +0000 (21:11 -0500)] 
Update faq.rst

7 years agoUpdate script_python.rst
TingPing [Thu, 2 Mar 2017 14:12:53 +0000 (09:12 -0500)] 
Update script_python.rst

7 years agoUpdate faq.rst
TingPing [Tue, 7 Feb 2017 22:50:59 +0000 (17:50 -0500)] 
Update faq.rst

7 years agoFix function name for plugin_pref_delete()
TingPing [Tue, 31 Jan 2017 02:31:36 +0000 (21:31 -0500)] 
Fix function name for plugin_pref_delete()

Closes hexchat/hexchat#1942

7 years agoUpdate script_python.rst
TingPing [Mon, 30 Jan 2017 01:51:01 +0000 (20:51 -0500)] 
Update script_python.rst

7 years agoUpdate script_lua.rst
TingPing [Wed, 18 Jan 2017 20:53:54 +0000 (15:53 -0500)] 
Update script_lua.rst

7 years agoAdd some references and explanations to Lua scripting docs (#37)
FichteFoll [Wed, 18 Jan 2017 20:53:06 +0000 (21:53 +0100)] 
Add some references and explanations to Lua scripting docs (#37)

* Add "Environment" section to Lua docs

Includes various links to external references and mentions availability
of GObject mappings via lgi.

* Tweak Environment section

* Environment section only *directly* applies to Win

* Remove example snippet for requiring modules

7 years agobuilding: Add autoconf-archive to apt example
Patrick Griffis [Mon, 2 Jan 2017 01:58:48 +0000 (20:58 -0500)] 
building: Add autoconf-archive to apt example

Closes hexchat/hexchat#1921

7 years agoRemove doat section
TingPing [Fri, 30 Dec 2016 00:50:10 +0000 (19:50 -0500)] 
Remove doat section

It is no longer a plugin

7 years agolua: More docs
Patrick Griffis [Sun, 18 Dec 2016 03:58:55 +0000 (22:58 -0500)] 
lua: More docs

7 years agolua: More docs
Patrick Griffis [Sun, 18 Dec 2016 03:52:48 +0000 (22:52 -0500)] 
lua: More docs

7 years agolua: Document users list
Patrick Griffis [Sun, 18 Dec 2016 03:49:42 +0000 (22:49 -0500)] 
lua: Document users list

7 years agoUpdate changelog.rst
Patrick Griffis [Sat, 10 Dec 2016 14:45:04 +0000 (09:45 -0500)] 
Update changelog.rst

7 years agoUpdate faq.rst
TingPing [Mon, 14 Nov 2016 07:04:49 +0000 (02:04 -0500)] 
Update faq.rst

7 years agoUpdate building.rst
TingPing [Sun, 6 Nov 2016 19:15:36 +0000 (14:15 -0500)] 
Update building.rst

7 years agoUpdate changelog.rst
TingPing [Sun, 23 Oct 2016 05:16:03 +0000 (01:16 -0400)] 
Update changelog.rst

7 years agoUpdate changelog.rst
Patrick Griffis [Sat, 22 Oct 2016 14:08:34 +0000 (10:08 -0400)] 
Update changelog.rst

7 years agoUse https instead of http
Jonathan [Wed, 19 Oct 2016 20:02:30 +0000 (22:02 +0200)] 
Use https instead of http

7 years agoUpdate tips.rst
TingPing [Tue, 18 Oct 2016 02:31:46 +0000 (22:31 -0400)] 
Update tips.rst

7 years agoUpdate developers.rst
TingPing [Fri, 14 Oct 2016 20:54:13 +0000 (16:54 -0400)] 
Update developers.rst

7 years agoUpdate developers.rst
TingPing [Fri, 14 Oct 2016 20:53:59 +0000 (16:53 -0400)] 
Update developers.rst

7 years agoUpdate changelog.rst
Patrick Griffis [Sat, 8 Oct 2016 22:44:42 +0000 (18:44 -0400)] 
Update changelog.rst

7 years agoFix date..
Patrick Griffis [Sat, 8 Oct 2016 22:22:36 +0000 (18:22 -0400)] 
Fix date..

7 years agoFix typo
Patrick Griffis [Sat, 8 Oct 2016 22:05:48 +0000 (18:05 -0400)] 
Fix typo

7 years agoUpdate changelog.rst
Patrick Griffis [Sat, 8 Oct 2016 22:01:25 +0000 (18:01 -0400)] 
Update changelog.rst

7 years agoUpdate tips.rst
TingPing [Sun, 25 Sep 2016 21:22:52 +0000 (17:22 -0400)] 
Update tips.rst

7 years agoUpdate faq.rst
TingPing [Sun, 25 Sep 2016 21:10:43 +0000 (17:10 -0400)] 
Update faq.rst

7 years agoUpdate plugins.rst
TingPing [Thu, 15 Sep 2016 15:34:53 +0000 (11:34 -0400)] 
Update plugins.rst

7 years agoUpdate faq.rst
TingPing [Thu, 15 Sep 2016 15:02:42 +0000 (11:02 -0400)] 
Update faq.rst

7 years agoUpdate tips.rst
TingPing [Sat, 10 Sep 2016 21:58:07 +0000 (17:58 -0400)] 
Update tips.rst

7 years agoDocument chanmodes
Patrick Griffis [Tue, 6 Sep 2016 18:56:45 +0000 (14:56 -0400)] 
Document chanmodes

7 years agoUpdate appearance.rst
TingPing [Sat, 27 Aug 2016 20:14:39 +0000 (16:14 -0400)] 
Update appearance.rst

7 years agoUpdate faq.rst
TingPing [Mon, 22 Aug 2016 20:23:05 +0000 (16:23 -0400)] 
Update faq.rst

7 years agoRevert "Update building.rst"
Patrick Griffis [Mon, 15 Aug 2016 13:46:33 +0000 (09:46 -0400)] 
Revert "Update building.rst"

This reverts commit 0701fa27139ec1903d7b49c90ec41afd54cc056c.

7 years agoUpdate building.rst
TingPing [Mon, 15 Aug 2016 13:11:41 +0000 (09:11 -0400)] 
Update building.rst

7 years agoMerge pull request #35 from Krzysiu/patch-1
TingPing [Mon, 8 Aug 2016 04:06:31 +0000 (00:06 -0400)] 
Merge pull request #35 from Krzysiu/patch-1

Fix typo

7 years agoThe name of the application is "Foobar2000".
Krzysiu [Sun, 7 Aug 2016 20:54:40 +0000 (22:54 +0200)] 
The name of the application is "Foobar2000".

7 years agoUpdate tips.rst
TingPing [Fri, 5 Aug 2016 01:34:04 +0000 (21:34 -0400)] 
Update tips.rst

7 years agoUpdate appearance.rst
TingPing [Fri, 8 Jul 2016 22:25:49 +0000 (18:25 -0400)] 
Update appearance.rst

7 years agoUpdate appearance.rst
TingPing [Fri, 8 Jul 2016 22:24:00 +0000 (18:24 -0400)] 
Update appearance.rst

7 years agoUpdate settings.rst
TingPing [Sun, 19 Jun 2016 20:00:23 +0000 (16:00 -0400)] 
Update settings.rst

7 years agoUpdate script_python.rst
TingPing [Thu, 26 May 2016 22:57:24 +0000 (18:57 -0400)] 
Update script_python.rst