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.
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.
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
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
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
OTHER --------------------------------------------------------------
I'm new to open source contributing. Appreciate any help.
hwj@BridgeportContractor.com
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
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:
OTHER --------------------------------------------------------------
I'm new to open source contributing. Appreciate any help.
hwj@BridgeportContractor.com
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).