From 5f3fecfd0f9935bdee9a5baacee56d5c47159925 Mon Sep 17 00:00:00 2001
From: Florian Spreckelsen <f.spreckelsen@indiscale.com>
Date: Tue, 19 Nov 2024 14:17:29 +0100
Subject: [PATCH] DOC: Fix header levels
---
src/caoscrawler/converters/__init__.py | 2 +-
src/doc/converters/standard_converters.rst | 11 ++++++-----
2 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/src/caoscrawler/converters/__init__.py b/src/caoscrawler/converters/__init__.py
index 3ec22233..edb7b363 100644
--- a/src/caoscrawler/converters/__init__.py
+++ b/src/caoscrawler/converters/__init__.py
@@ -18,7 +18,7 @@
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
-"""Submdule containing all default and optional converters."""
+"""Submodule containing all default and optional converters."""
from .. import utils
from .converters import *
diff --git a/src/doc/converters/standard_converters.rst b/src/doc/converters/standard_converters.rst
index 0520f56b..f7f18794 100644
--- a/src/doc/converters/standard_converters.rst
+++ b/src/doc/converters/standard_converters.rst
@@ -369,13 +369,13 @@ are generated by the XMLTagConverter.
ZipFileConverter
-----------------
+================
This converter opens zip files, unzips them into a temporary directory and
exposes its contents as File structure elements.
Usage Example:
-==============
+--------------
.. code-block:: yaml
@@ -390,6 +390,7 @@ Usage Example:
type: File
match: description.odt$
-This converter will match and open files called `example.zip`.
-If the file contains a directory called `experiments` it will be processed further by the respective
-converter in the subtree. The same is true for a file called `description.odt`.
+This converter will match and open files called ``example.zip``. If
+the file contains a directory called ``experiments`` it will be
+processed further by the respective converter in the subtree. The same
+is true for a file called ``description.odt``.
--
GitLab