Fix RsT errors in docs and rename html recipe to doc

This commit is contained in:
JC Brand 2019-11-22 12:57:51 +01:00
parent e4010185dc
commit 86809d9301
4 changed files with 68 additions and 56 deletions

View File

@ -40,7 +40,7 @@ help:
@echo " check Run all tests." @echo " check Run all tests."
@echo " dev Set up the development environment and build unminified resources. To force a fresh start, run 'make clean' first." @echo " dev Set up the development environment and build unminified resources. To force a fresh start, run 'make clean' first."
@echo " devserver Set up the development environment and start the webpack dev server." @echo " devserver Set up the development environment and start the webpack dev server."
@echo " html Make standalone HTML files of the documentation." @echo " doc Make standalone HTML files of the documentation."
@echo " po Generate gettext PO files for each i18n language." @echo " po Generate gettext PO files for each i18n language."
@echo " pot Generate a gettext POT file to be used for translations." @echo " pot Generate a gettext POT file to be used for translations."
@echo " release Prepare a new release of converse.js. E.g. make release VERSION=0.9.5" @echo " release Prepare a new release of converse.js. E.g. make release VERSION=0.9.5"
@ -216,7 +216,10 @@ check: eslint dev
docsdev: ./bin/activate .installed.cfg docsdev: ./bin/activate .installed.cfg
.PHONY: html .PHONY: html
html: stamp-npm docsdev apidoc html: doc
.PHONY: doc
doc: stamp-npm docsdev apidoc
rm -rf $(BUILDDIR)/html rm -rf $(BUILDDIR)/html
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
make apidoc make apidoc

View File

@ -319,20 +319,20 @@ in to their XMPP account.
.. note:: .. note::
The interaction between ``keepalive`` and ``auto_login`` is unfortunately The interaction between ``keepalive`` and ``auto_login`` is unfortunately
inconsistent depending on the ``authentication`` method used. inconsistent depending on the ``authentication`` method used.
If ``auto_login`` is set to ``false`` and ``authentication`` is set to If ``auto_login`` is set to ``false`` and ``authentication`` is set to
``anonymous``, ``external`` or ``prebind``, then Converse won't automatically ``anonymous``, ``external`` or ``prebind``, then Converse won't automatically
log the user in. log the user in.
If ``authentication`` set to ``login`` the situation is much more If ``authentication`` set to ``login`` the situation is much more
ambiguous, since we don't have a way to distinguish between wether we're ambiguous, since we don't have a way to distinguish between wether we're
restoring a previous session (``keepalive``) or whether we're restoring a previous session (``keepalive``) or whether we're
automatically setting up a new session (``auto_login``). automatically setting up a new session (``auto_login``).
So currently if EITHER ``keepalive`` or ``auto_login`` is ``true`` and So currently if EITHER ``keepalive`` or ``auto_login`` is ``true`` and
``authentication`` is set to ``login``, then Converse will try to log the user in. ``authentication`` is set to ``login``, then Converse will try to log the user in.
auto_away auto_away
@ -697,19 +697,23 @@ The placeholder text shown in the domain input on the registration form.
emoji_categories emoji_categories
---------------- ----------------
* Default::: * Default:
{
"smileys": ":grinning:", ::
"people": ":thumbsup:",
"activity": ":soccer:", {
"travel": ":motorcycle:", "smileys": ":grinning:",
"objects": ":bomb:", "people": ":thumbsup:",
"nature": ":rainbow:", "activity": ":soccer:",
"food": ":hotdog:", "travel": ":motorcycle:",
"symbols": ":musical_note:", "objects": ":bomb:",
"flags": ":flag_ac:", "nature": ":rainbow:",
"custom": ":converse:" "food": ":hotdog:",
} "symbols": ":musical_note:",
"flags": ":flag_ac:",
"custom": ":converse:"
}
This setting lets you define the categories that are available in the emoji This setting lets you define the categories that are available in the emoji
picker, as well as the default image that's shown for each category. picker, as well as the default image that's shown for each category.
@ -732,19 +736,23 @@ entries to the map under the ``custom`` key.
emoji_categories_label emoji_categories_label
---------------------- ----------------------
* Default::: * Default:
{
"smileys": "Smileys and emotions", ::
"people": "People",
"activity": "Activities", {
"travel": "Travel", "smileys": "Smileys and emotions",
"objects": "Objects", "people": "People",
"nature": "Animals and nature", "activity": "Activities",
"food": "Food and drink", "travel": "Travel",
"symbols": "Symbols", "objects": "Objects",
"flags": "Flags", "nature": "Animals and nature",
"custom": "Stickers" "food": "Food and drink",
} "symbols": "Symbols",
"flags": "Flags",
"custom": "Stickers"
}
This setting lets you pass in the text value that goes into the `title` This setting lets you pass in the text value that goes into the `title`
attribute for the emoji categories. These strings will be translated, but for attribute for the emoji categories. These strings will be translated, but for
@ -907,9 +915,6 @@ therefore what may be given as value for the :ref:`i18n` option.
Any other locales will be ignored. Any other locales will be ignored.
When self-hosting, also make sure that the locales are served and therefore
fetchable (via ``XMLHttpRequest``) at the URL specified by :ref:`locales-url`.
locked_domain locked_domain
------------- -------------
@ -966,15 +971,15 @@ muc_mention_autocomplete_filter
* Default: ``contains`` * Default: ``contains``
The method used for filtering MUC participants when using auto-complete. The method used for filtering MUC participants when using auto-complete.
Valid values are ``contains`` and ``starts_with``. Valid values are ``contains`` and ``starts_with``.
muc_mention_autocomplete_show_avatar muc_mention_autocomplete_show_avatar
------------------------------- ------------------------------------
* Default: ``true`` * Default: ``true``
Show avatars of MUC participants when using auto-complete. Show avatars of MUC participants when using auto-complete.
message_archiving message_archiving
----------------- -----------------
@ -1271,8 +1276,7 @@ nickname is mentioned in a chatroom.
Inside the ``./sounds`` directory of the Converse repo you'll see MP3 and Ogg Inside the ``./sounds`` directory of the Converse repo you'll see MP3 and Ogg
formatted sound files. We need both, because neither format is supported by all browsers. formatted sound files. We need both, because neither format is supported by all browsers.
You can set the URL where the sound files are hosted with the `sounds_path`_ You can set the URL where the sound files are hosted with the `sounds_path`_ option.
option.
Requires the `src/converse-notification.js` plugin. Requires the `src/converse-notification.js` plugin.
@ -1329,10 +1333,12 @@ providers_link
The hyperlink on the registration form which points to a directory of public The hyperlink on the registration form which points to a directory of public
XMPP servers. XMPP servers.
.. _`assets_path`:
assets_path assets_path
----------- -----------
* Default: The `publicPath <https://webpack.js.org/guides/public-path/>`_ value configured in the relevant Webpack configuration. * Default: ``'/dist/'`` or the `publicPath <https://webpack.js.org/guides/public-path/>`_ value as configured in the relevant Webpack configuration.
Since version 5.0.0, Converse serves a smaller bundle by extracting various Since version 5.0.0, Converse serves a smaller bundle by extracting various
resources (for example emojis and translations) into separate files (aka resources (for example emojis and translations) into separate files (aka

View File

@ -137,10 +137,13 @@ For more info, refer to the :ref:`show-desktop-notifications` configuration sett
Multilingual Support Multilingual Support
==================== ====================
Converse is translated into multiple languages. Translations are supplied in Converse is translated into over 30 languages. Translations can be added or
JSON format and are loaded on demand. Converse will expect to find the updated on `Weblate <https://hosted.weblate.org/projects/conversejs/>`_.
translations in the ``/locales`` path of your site. This can be changed via the
:ref:`locales-url` configuration setting. Translations are supplied in JSON format and are loaded on demand. Converse will expect to find the
translations in the ``/dist/locales`` path of your site. This path can be
changed via the :ref:`assets_path` configuration setting.
Moderating chatrooms Moderating chatrooms
==================== ====================

View File

@ -18,14 +18,14 @@ directory, or through the web at `weblate <https://hosted.weblate.org/projects/c
As of version 3.3.0, Converse no longer automatically bundles translations As of version 3.3.0, Converse no longer automatically bundles translations
in its source file and instead fetches only the relevant locale for the current in its source file and instead fetches only the relevant locale for the current
session from a URL as specified by the :ref:`locales-url` setting. session from a URL as specified by the :ref:`assets_path` setting.
There are three configuration settings relevant to translations and There are three configuration settings relevant to translations and
localisation. You're encouraged to read the documentation for each of them. localisation. You're encouraged to read the documentation for each of them.
* :ref:`i18n` * :ref:`i18n`
* :ref:`locales` * :ref:`locales`
* :ref:`locales-url` * :ref:`assets_path`
Manually updating translations Manually updating translations
============================== ==============================