Documentation: many small changes

Summary

Many small changes, for #112 (closed)

Focus

• Are the documentation changes correct?
• Do they add to readability or understandability?

Test Environment

make doc && xdg-open build/doc/html/index.html

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caoscrawler/converters.py

@@ -389,8 +389,8 @@ class Converter(object, metaclass=ABCMeta):
         Extract information from the structure element and store them as values in the
         general store.
 
-        Parameters:
-        ------------
+        Parameters
+        ----------
 
         values: GeneralStore
             The GeneralStore to store values in.
@@ -409,8 +409,8 @@ class Converter(object, metaclass=ABCMeta):
         Check if transformers are defined using the "transform" keyword.
         Then apply the transformers to the variables defined in GeneralStore "values".
 
-        Parameters:
-        ------------
+        Parameters
+        ----------
 
         values: GeneralStore
             The GeneralStore to store values in.
@@ -765,6 +765,12 @@ schema_resource:
 
 
 class DictElementConverter(Converter):
+    """
+**Operates on:** :py:class:`caoscrawler.structure_elements.DictElement`
+
+**Generates:** :py:class:`caoscrawler.structure_elements.StructureElement`
+    """
+
     def create_children(self, generalStore: GeneralStore, element: StructureElement):
         # TODO: See comment on types and inheritance
         if not isinstance(element, DictElement):
@@ -1154,6 +1160,12 @@ class TableConverter(Converter):
 
 
 class XLSXTableConverter(TableConverter):
+    """
+**Operates on:** :py:class:`caoscrawler.structure_elements.File`
+
+**Generates:** :py:class:`caoscrawler.structure_elements.DictElement`
+    """
+
     def get_options(self):
         return self._get_options([
             ("sheet_name", str),