weblate/docs/formats/ruby.rst
Gersona 725bd96349
feat(docs): Automatically generate format features docmentation (#18106)
* initial implementation suggestion

* basic supported features snippets generation

* Add API identifiers, read-only strings and common extensions to features table

* generate doc features snippet files

* autogenerated snippets cleanup

* changelog update

* delete one file to test auto-update

* replace SUPPORTS_FUZZY with file format additional_states flag

* docs: Documentation snippets update

* fix include statetement typo

* fix incorrect monolingual attributes

* minor styling change

* docs: Documentation snippets update

* exclude snippets from being treated as standalone documents

* Set YAMLFormat as both mono/bilingual

* docs: Documentation snippets update

* fix duplicate format IDs

* only use backwards quotes for literals

---------

Co-authored-by: gersona <6675010+gersona@users.noreply.github.com>
Co-authored-by: Michal Čihař <michal@weblate.org>
2026-04-01 15:41:20 +00:00

36 lines
1.2 KiB
ReStructuredText

.. _ryaml:
Ruby YAML files
---------------
.. index::
pair: Ruby YAML; file format
Ruby i18n YAML files with language as root node.
.. seealso::
* :doc:`tt:formats/yaml`
* :ref:`yaml`
Example Ruby i18n YAML file:
.. literalinclude:: ../../weblate/trans/tests/data/cs.ryml
:language: yaml
.. include:: /snippets/format-features/ruby-yaml-features.rst
Weblate configuration
+++++++++++++++++++++
+-------------------------------------------------------------------+
| Typical Weblate :ref:`component` |
+================================+==================================+
| File mask | ``translations/messages.*.yml`` |
+--------------------------------+----------------------------------+
| Monolingual base language file | ``translations/messages.en.yml`` |
+--------------------------------+----------------------------------+
| Template for new translations | `Empty` |
+--------------------------------+----------------------------------+
| File format | `Ruby YAML file` |
+--------------------------------+----------------------------------+