Update the documentation

LeMyst · Jan 3, 2025 · 7e5fd89 · 7e5fd89
1 parent 9370586
commit 7e5fd89
Show file tree

Hide file tree

Showing 54 changed files with 486 additions and 435 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,10 @@
 # Sphinx-apidoc
 
+```bash
+python -m poetry install --with docs
+sphinx-apidoc -e -f -o docs/source ./wikibaseintegrator/ -t docs/source/_templates
+```
+
 ```shell
 sphinx-apidoc.exe -e -f -o docs\source .\wikibaseintegrator\ -t docs\source\_templates
 ```
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator
-==================
-
-.. toctree::
-   :maxdepth: 4
-
-   wikibaseintegrator
+wikibaseintegrator
+==================
+
+.. toctree::
+   :maxdepth: 4
+
+   wikibaseintegrator
diff --git a/docs/source/wikibaseintegrator.datatypes.basedatatype.rst b/docs/source/wikibaseintegrator.datatypes.basedatatype.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.basedatatype
-=========================================
-
-.. automodule:: wikibaseintegrator.datatypes.basedatatype
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.basedatatype module
+================================================
+
+.. automodule:: wikibaseintegrator.datatypes.basedatatype
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.commonsmedia.rst b/docs/source/wikibaseintegrator.datatypes.commonsmedia.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.commonsmedia
-=========================================
-
-.. automodule:: wikibaseintegrator.datatypes.commonsmedia
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.commonsmedia module
+================================================
+
+.. automodule:: wikibaseintegrator.datatypes.commonsmedia
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.entityschema.rst b/docs/source/wikibaseintegrator.datatypes.entityschema.rst
@@ -1,5 +1,5 @@
-wikibaseintegrator.datatypes.entityschema
-=========================================
+wikibaseintegrator.datatypes.entityschema module
+================================================
 
 .. automodule:: wikibaseintegrator.datatypes.entityschema
    :members:

diff --git a/docs/source/wikibaseintegrator.datatypes.externalid.rst b/docs/source/wikibaseintegrator.datatypes.externalid.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.externalid
-=======================================
-
-.. automodule:: wikibaseintegrator.datatypes.externalid
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.externalid module
+==============================================
+
+.. automodule:: wikibaseintegrator.datatypes.externalid
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.extra.edtf.rst b/docs/source/wikibaseintegrator.datatypes.extra.edtf.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.extra.edtf
-=======================================
-
-.. automodule:: wikibaseintegrator.datatypes.extra.edtf
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.extra.edtf module
+==============================================
+
+.. automodule:: wikibaseintegrator.datatypes.extra.edtf
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.extra.localmedia.rst b/docs/source/wikibaseintegrator.datatypes.extra.localmedia.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.extra.localmedia
-=============================================
-
-.. automodule:: wikibaseintegrator.datatypes.extra.localmedia
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.extra.localmedia module
+====================================================
+
+.. automodule:: wikibaseintegrator.datatypes.extra.localmedia
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.extra.rst b/docs/source/wikibaseintegrator.datatypes.extra.rst
@@ -1,9 +1,19 @@
-wikibaseintegrator.datatypes.extra
-==================================
-
-
-.. toctree::
-   :maxdepth: 4
-
-   wikibaseintegrator.datatypes.extra.edtf
-   wikibaseintegrator.datatypes.extra.localmedia
+wikibaseintegrator.datatypes.extra package
+==========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wikibaseintegrator.datatypes.extra.edtf
+   wikibaseintegrator.datatypes.extra.localmedia
+
+Module contents
+---------------
+
+.. automodule:: wikibaseintegrator.datatypes.extra
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.form.rst b/docs/source/wikibaseintegrator.datatypes.form.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.form
-=================================
-
-.. automodule:: wikibaseintegrator.datatypes.form
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.form module
+========================================
+
+.. automodule:: wikibaseintegrator.datatypes.form
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.geoshape.rst b/docs/source/wikibaseintegrator.datatypes.geoshape.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.geoshape
-=====================================
-
-.. automodule:: wikibaseintegrator.datatypes.geoshape
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.geoshape module
+============================================
+
+.. automodule:: wikibaseintegrator.datatypes.geoshape
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.globecoordinate.rst b/docs/source/wikibaseintegrator.datatypes.globecoordinate.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.globecoordinate
-============================================
-
-.. automodule:: wikibaseintegrator.datatypes.globecoordinate
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.globecoordinate module
+===================================================
+
+.. automodule:: wikibaseintegrator.datatypes.globecoordinate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.item.rst b/docs/source/wikibaseintegrator.datatypes.item.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.item
-=================================
-
-.. automodule:: wikibaseintegrator.datatypes.item
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.item module
+========================================
+
+.. automodule:: wikibaseintegrator.datatypes.item
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.lexeme.rst b/docs/source/wikibaseintegrator.datatypes.lexeme.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.lexeme
-===================================
-
-.. automodule:: wikibaseintegrator.datatypes.lexeme
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.lexeme module
+==========================================
+
+.. automodule:: wikibaseintegrator.datatypes.lexeme
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.math.rst b/docs/source/wikibaseintegrator.datatypes.math.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.math
-=================================
-
-.. automodule:: wikibaseintegrator.datatypes.math
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.math module
+========================================
+
+.. automodule:: wikibaseintegrator.datatypes.math
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.monolingualtext.rst b/docs/source/wikibaseintegrator.datatypes.monolingualtext.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.monolingualtext
-============================================
-
-.. automodule:: wikibaseintegrator.datatypes.monolingualtext
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.monolingualtext module
+===================================================
+
+.. automodule:: wikibaseintegrator.datatypes.monolingualtext
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.musicalnotation.rst b/docs/source/wikibaseintegrator.datatypes.musicalnotation.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.musicalnotation
-============================================
-
-.. automodule:: wikibaseintegrator.datatypes.musicalnotation
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.musicalnotation module
+===================================================
+
+.. automodule:: wikibaseintegrator.datatypes.musicalnotation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.property.rst b/docs/source/wikibaseintegrator.datatypes.property.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.property
-=====================================
-
-.. automodule:: wikibaseintegrator.datatypes.property
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.property module
+============================================
+
+.. automodule:: wikibaseintegrator.datatypes.property
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.quantity.rst b/docs/source/wikibaseintegrator.datatypes.quantity.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.quantity
-=====================================
-
-.. automodule:: wikibaseintegrator.datatypes.quantity
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.quantity module
+============================================
+
+.. automodule:: wikibaseintegrator.datatypes.quantity
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.rst b/docs/source/wikibaseintegrator.datatypes.rst
@@ -1,36 +1,44 @@
-wikibaseintegrator.datatypes
-============================
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   wikibaseintegrator.datatypes.extra
-
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 4
-
-   wikibaseintegrator.datatypes.basedatatype
-   wikibaseintegrator.datatypes.commonsmedia
-   wikibaseintegrator.datatypes.entityschema
-   wikibaseintegrator.datatypes.externalid
-   wikibaseintegrator.datatypes.form
-   wikibaseintegrator.datatypes.geoshape
-   wikibaseintegrator.datatypes.globecoordinate
-   wikibaseintegrator.datatypes.item
-   wikibaseintegrator.datatypes.lexeme
-   wikibaseintegrator.datatypes.math
-   wikibaseintegrator.datatypes.monolingualtext
-   wikibaseintegrator.datatypes.musicalnotation
-   wikibaseintegrator.datatypes.property
-   wikibaseintegrator.datatypes.quantity
-   wikibaseintegrator.datatypes.sense
-   wikibaseintegrator.datatypes.string
-   wikibaseintegrator.datatypes.tabulardata
-   wikibaseintegrator.datatypes.time
-   wikibaseintegrator.datatypes.url
+wikibaseintegrator.datatypes package
+====================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wikibaseintegrator.datatypes.extra
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wikibaseintegrator.datatypes.basedatatype
+   wikibaseintegrator.datatypes.commonsmedia
+   wikibaseintegrator.datatypes.entityschema
+   wikibaseintegrator.datatypes.externalid
+   wikibaseintegrator.datatypes.form
+   wikibaseintegrator.datatypes.geoshape
+   wikibaseintegrator.datatypes.globecoordinate
+   wikibaseintegrator.datatypes.item
+   wikibaseintegrator.datatypes.lexeme
+   wikibaseintegrator.datatypes.math
+   wikibaseintegrator.datatypes.monolingualtext
+   wikibaseintegrator.datatypes.musicalnotation
+   wikibaseintegrator.datatypes.property
+   wikibaseintegrator.datatypes.quantity
+   wikibaseintegrator.datatypes.sense
+   wikibaseintegrator.datatypes.string
+   wikibaseintegrator.datatypes.tabulardata
+   wikibaseintegrator.datatypes.time
+   wikibaseintegrator.datatypes.url
+
+Module contents
+---------------
+
+.. automodule:: wikibaseintegrator.datatypes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.sense.rst b/docs/source/wikibaseintegrator.datatypes.sense.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.sense
-==================================
-
-.. automodule:: wikibaseintegrator.datatypes.sense
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.sense module
+=========================================
+
+.. automodule:: wikibaseintegrator.datatypes.sense
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wikibaseintegrator.datatypes.string.rst b/docs/source/wikibaseintegrator.datatypes.string.rst
@@ -1,7 +1,7 @@
-wikibaseintegrator.datatypes.string
-===================================
-
-.. automodule:: wikibaseintegrator.datatypes.string
-   :members:
-   :undoc-members:
-   :show-inheritance:
+wikibaseintegrator.datatypes.string module
+==========================================
+
+.. automodule:: wikibaseintegrator.datatypes.string
+   :members:
+   :undoc-members:
+   :show-inheritance: