Tim Hoffmann
6cf3f9238e
Consistently use sentence case for headings ( #12987 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-08 23:04:18 +01:00
Jeremy Bowman
0cbdd98ffb
Correctly support custom gettext output templates ( #12645 )
...
Co-authored-by: Jeremy Bowman <jmbowman@alum.mit.edu>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-08-11 20:34:04 +01:00
Adam Turner
55eddad705
Use proper Pygments lexers
2024-07-24 15:21:25 +01:00
Adam Turner
f2640a4286
Standardise on "reStructuredText" over "reST" in documentation
2024-07-15 02:15:52 +01:00
Adam Turner
82edc3d385
Rewrite `usage/configuration.rst` ( #12537 )
...
- Remove now-removed configuration values
- Use obvious 'unset' defaults for ``project`` and ``author``
- Prefer 'e.g.' to 'ex.'
- Allow non-list sequence types in various configuration values
- Add types and defaults to every confval directive
2024-07-10 21:43:14 +01:00
James Addison
751e9162c0
[maintenance] self-linkcheck the Sphinx documentation. ( #12487 )
...
Fixups for a few broken links in the Sphinx documentation, as found using the `linkcheck` builder.
2024-06-27 23:32:50 +02:00
Rafael Fontenelle
da076d1854
DOCS: Improve Internationalization guide ( #12377 )
...
Documentation needs to mention the new Transifex CLI tool instead of the deprecated transifex-client
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
2024-06-07 12:30:01 +02:00
Bénédikt Tran
b2069fb64f
[lint] update Makefile and lint doc ( #12117 )
2024-03-17 14:45:56 +01:00
Adam Turner
b935915c57
Improve make-mode documentation ( #11692 )
2023-09-21 09:39:39 +01:00
Adam Turner
066e0fabc6
Add translation progress information ( #11509 )
...
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
2023-07-24 20:19:31 +01:00
Adam Turner
2a9e805206
Remove the deprecated Setuptools integration ( #11363 )
2023-04-27 01:22:04 +01:00
Maciej Olko
5a6b2b16b6
Add link to Weblate's Sphinx docs in intl documentation ( #11332 )
...
Add link to Weblate in intl documentation
2023-04-16 21:21:57 +02:00
Adam Turner
7ecf037280
Enable 'nit-picky mode' for Sphinx's documentation
...
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
2023-04-06 23:11:39 +01:00
Jérémie Tarot
d8977d3e57
docs: intl.rst: small fixes while translating ( #11020 )
2022-12-07 13:53:44 +01:00
Takeshi KOMIYA
223b1a94f2
Merge branch '4.x'
2022-03-28 01:00:37 +09:00
Takeshi KOMIYA
fa63db8dc6
Update versionadded to 4.5
2022-03-06 18:47:11 +09:00
Jean Abou Samra
94d78d8747
Close #3985 : Implement #noqa for i18n
...
When cross-references in the original paragraph and the translated
paragraph do not match, a warning is emitted. It is useful, because
it allows to catch mistakes, but it can also be an annoyance since
sometimes it is expected that the cross-references will not match.
For example, a reference that is repeated in the original text may
need to be factored out for good style in the target language.
Another example: if the translator needs to translate a universally
understood term in the source language into a term that not everyone
knows is the translation of this original term, adding a reference to
the glossary can be warranted. This allows the translated message to
start with '#noqa' in order to disable the warning.
2022-02-15 19:51:06 +01:00
Takeshi KOMIYA
0663602bb9
Close #9595 : Deprecate setuptools integration
2022-01-01 20:19:27 +09:00
Takeshi KOMIYA
dd27e35e4c
doc: Use "console" for the highlight language of console output
...
Using "console" language is better for the console example (including
command-line prompt)
2021-12-13 14:20:37 +09:00
Juan Luis Cano Rodríguez
c9d2a73d93
Rename to root document
2021-06-22 15:27:54 +02:00
Takeshi KOMIYA
e0500f7354
doc: Fix docslint misunderstanding scope of code-blocks
2021-06-06 13:24:06 +09:00
Grey Li
6a0dae08d0
Fix typo in doc/intl.rst
...
The pot files are in the gettext folder instead of locale folder.
2021-05-27 17:28:10 +08:00
igo95862
3f0a840c54
doc: Upgraded plantuml.org link to HTTPS
2021-05-17 20:39:14 +03:00
igo95862
bb173a5789
doc: Moved flask links to new home and HTTPS
...
Seems like Flask is no longer pocoo project but
palletsprojects.com
2021-05-17 20:39:13 +03:00
igo95862
cfa449624d
doc: Moved Jinja links to new home page and HTTPS
...
Seems like Jinja is no longer pocoo project but
palletsprojects.com
2021-05-17 20:38:48 +03:00
Tetsuo Koyama
9fe3fe4f6b
Add "Getting Started as a Translator"
2020-09-20 01:08:21 +09:00
Tetsuo Koyama
eef2f2a8b6
✏️ Fix grammer
2020-09-20 00:53:57 +09:00
Chris Mayo
fe4a158caf
Fix typos in the documentation
2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
d2fdc851fa
doc: Add translation.png to build latexpdf successfully
2020-07-07 22:19:21 +09:00
Takeshi KOMIYA
68375c92f2
Fix #7488 : Update docs
2020-04-19 23:01:57 +09:00
Septatrix
97133d4bf0
Configure plantuml to generate svg files ( fixes #7134 )
2020-03-10 19:09:31 +01:00
Takeshi KOMIYA
7851550cd8
doc: Fix ambiguous confval entries and references
2019-12-29 23:23:46 +09:00
Tetsuo Koyama
7fbd9c02d0
🎨 Fixed issue #6789
2019-11-04 20:28:24 +09:00
Takeshi KOMIYA
9b2423c5bb
doclinter: restrict by 90 columns
2019-05-26 10:53:53 +09:00
Stephen Finucane
71e8477597
doc: Add "websupport" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:23:06 +01:00
Stephen Finucane
23afd29cbb
doc: Add "setuptools" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:22:38 +01:00
Stephen Finucane
d380617c3b
doc: Add "internationalization" to the usage guide
...
This is added to the new "advanced" subsection.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:20:46 +01:00
