Skip to content

Commit

Permalink
[Backport 12.4] [TASK] Streamline rst files (#776) (#778)
Browse files Browse the repository at this point in the history
Releases: main, 12.4
  • Loading branch information
brotkrueml authored Sep 12, 2023
1 parent 98c4ca6 commit 3c161f8
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 5 deletions.
4 changes: 2 additions & 2 deletions Documentation/BestPractises/CommonFields.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Enablecolumns
This field is used to enable soft delete of records. In can be configured
by :ref:`ctrl->enablecolumns->fe_group <ctrl-reference-enablecolumns>`:

.. include:: /CodeSnippets/Manual/Ctrl/FeGroup.rst
.. include:: /CodeSnippets/Manual/Ctrl/FeGroup.rst.txt

.. warning::
These enable fields are only respected in the frontend if you
Expand All @@ -100,7 +100,7 @@ Manual sorting in the backend
This field is used to manually sort records in the backend. In can be configured
by :ref:`ctrl->sortby <ctrl-reference-sortby>`:

.. include:: /CodeSnippets/Manual/Ctrl/Sorting.rst
.. include:: /CodeSnippets/Manual/Ctrl/Sorting.rst.txt

.. attention::
The sortby field contains an integer and is managed by the DataHandler. It
Expand Down
5 changes: 4 additions & 1 deletion Documentation/ColumnsConfig/Introduction/Index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.. include:: /Includes.rst.txt

============
Introduction
------------
============

Section :code:`['columns'][*]['config']` (where :code:`*` stands for a table column) is the main workhorse when it comes to single field configuration.
The main property is :code:`type`, it specifies the DataHandler processing and database value. Additionally,
Expand Down
4 changes: 4 additions & 0 deletions Documentation/ColumnsConfig/Type/Index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:orphan:

====
Type
====

See :ref:`columns-types`.
2 changes: 1 addition & 1 deletion Documentation/ColumnsConfig/Type/Select/Tree/Examples.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. include:: /Includes.rst.txt


========
Examples
========

Expand Down
1 change: 1 addition & 0 deletions Documentation/ColumnsConfig/Type/Slug/Introduction.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. include:: /Includes.rst.txt
.. _columns-slug-introduction:

============
Introduction
============

Expand Down
1 change: 1 addition & 0 deletions Documentation/ColumnsConfig/Type/Slug/Properties/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
.. _columns-slug-properties:
.. _columns-slug-properties-type:

==========
Properties
==========

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Ctrl/Properties/Sortby.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ sortby
DataHandler will write these integers into that field, which is most likely *not* what you want. Use `default_sortby`
in this case.

.. include:: /CodeSnippets/Manual/Ctrl/Sorting.rst
.. include:: /CodeSnippets/Manual/Ctrl/Sorting.rst.txt

0 comments on commit 3c161f8

Please sign in to comment.