Skip to content

Commit 7e5fd89

Browse files
LeMystLeMyst
authored
Update the documentation
1 parent 9370586 commit 7e5fd89

File tree

54 files changed

+486
-435
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+486
-435
lines changed

‎docs/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Sphinx-apidoc
22

3+
```bash
4+
python -m poetry install --with docs
5+
sphinx-apidoc -e -f -o docs/source ./wikibaseintegrator/ -t docs/source/_templates
6+
```
7+
38
```shell
49
sphinx-apidoc.exe -e -f -o docs\source .\wikibaseintegrator\ -t docs\source\_templates
510
```

‎docs/source/modules.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator
2-
==================
3-
4-
.. toctree::
5-
:maxdepth: 4
6-
7-
wikibaseintegrator
1+
wikibaseintegrator
2+
==================
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
wikibaseintegrator

‎docs/source/wikibaseintegrator.datatypes.basedatatype.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.basedatatype
2-
=========================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.basedatatype
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.basedatatype module
2+
================================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.basedatatype
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.commonsmedia.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.commonsmedia
2-
=========================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.commonsmedia
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.commonsmedia module
2+
================================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.commonsmedia
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.entityschema.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
wikibaseintegrator.datatypes.entityschema
2-
=========================================
1+
wikibaseintegrator.datatypes.entityschema module
2+
================================================
33

44
.. automodule:: wikibaseintegrator.datatypes.entityschema
55
:members:

‎docs/source/wikibaseintegrator.datatypes.externalid.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.externalid
2-
=======================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.externalid
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.externalid module
2+
==============================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.externalid
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.extra.edtf.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.extra.edtf
2-
=======================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.extra.edtf
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.extra.edtf module
2+
==============================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.extra.edtf
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.extra.localmedia.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.extra.localmedia
2-
=============================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.extra.localmedia
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.extra.localmedia module
2+
====================================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.extra.localmedia
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.extra.rst

+19-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
wikibaseintegrator.datatypes.extra
2-
==================================
3-
4-
5-
.. toctree::
6-
:maxdepth: 4
7-
8-
wikibaseintegrator.datatypes.extra.edtf
9-
wikibaseintegrator.datatypes.extra.localmedia
1+
wikibaseintegrator.datatypes.extra package
2+
==========================================
3+
4+
Submodules
5+
----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
wikibaseintegrator.datatypes.extra.edtf
11+
wikibaseintegrator.datatypes.extra.localmedia
12+
13+
Module contents
14+
---------------
15+
16+
.. automodule:: wikibaseintegrator.datatypes.extra
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.form.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.form
2-
=================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.form
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.form module
2+
========================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.form
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.geoshape.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.geoshape
2-
=====================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.geoshape
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.geoshape module
2+
============================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.geoshape
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.globecoordinate.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.globecoordinate
2-
============================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.globecoordinate
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.globecoordinate module
2+
===================================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.globecoordinate
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.item.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.item
2-
=================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.item
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.item module
2+
========================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.item
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.lexeme.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.lexeme
2-
===================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.lexeme
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.lexeme module
2+
==========================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.lexeme
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.math.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.math
2-
=================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.math
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.math module
2+
========================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.math
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.monolingualtext.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.monolingualtext
2-
============================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.monolingualtext
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.monolingualtext module
2+
===================================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.monolingualtext
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.musicalnotation.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.musicalnotation
2-
============================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.musicalnotation
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.musicalnotation module
2+
===================================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.musicalnotation
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.property.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.property
2-
=====================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.property
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.property module
2+
============================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.property
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.quantity.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.quantity
2-
=====================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.quantity
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.quantity module
2+
============================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.quantity
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.rst

+44-36
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
1-
wikibaseintegrator.datatypes
2-
============================
3-
4-
Subpackages
5-
-----------
6-
7-
.. toctree::
8-
:maxdepth: 4
9-
10-
wikibaseintegrator.datatypes.extra
11-
12-
Submodules
13-
----------
14-
15-
.. toctree::
16-
:maxdepth: 4
17-
18-
wikibaseintegrator.datatypes.basedatatype
19-
wikibaseintegrator.datatypes.commonsmedia
20-
wikibaseintegrator.datatypes.entityschema
21-
wikibaseintegrator.datatypes.externalid
22-
wikibaseintegrator.datatypes.form
23-
wikibaseintegrator.datatypes.geoshape
24-
wikibaseintegrator.datatypes.globecoordinate
25-
wikibaseintegrator.datatypes.item
26-
wikibaseintegrator.datatypes.lexeme
27-
wikibaseintegrator.datatypes.math
28-
wikibaseintegrator.datatypes.monolingualtext
29-
wikibaseintegrator.datatypes.musicalnotation
30-
wikibaseintegrator.datatypes.property
31-
wikibaseintegrator.datatypes.quantity
32-
wikibaseintegrator.datatypes.sense
33-
wikibaseintegrator.datatypes.string
34-
wikibaseintegrator.datatypes.tabulardata
35-
wikibaseintegrator.datatypes.time
36-
wikibaseintegrator.datatypes.url
1+
wikibaseintegrator.datatypes package
2+
====================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
wikibaseintegrator.datatypes.extra
11+
12+
Submodules
13+
----------
14+
15+
.. toctree::
16+
:maxdepth: 4
17+
18+
wikibaseintegrator.datatypes.basedatatype
19+
wikibaseintegrator.datatypes.commonsmedia
20+
wikibaseintegrator.datatypes.entityschema
21+
wikibaseintegrator.datatypes.externalid
22+
wikibaseintegrator.datatypes.form
23+
wikibaseintegrator.datatypes.geoshape
24+
wikibaseintegrator.datatypes.globecoordinate
25+
wikibaseintegrator.datatypes.item
26+
wikibaseintegrator.datatypes.lexeme
27+
wikibaseintegrator.datatypes.math
28+
wikibaseintegrator.datatypes.monolingualtext
29+
wikibaseintegrator.datatypes.musicalnotation
30+
wikibaseintegrator.datatypes.property
31+
wikibaseintegrator.datatypes.quantity
32+
wikibaseintegrator.datatypes.sense
33+
wikibaseintegrator.datatypes.string
34+
wikibaseintegrator.datatypes.tabulardata
35+
wikibaseintegrator.datatypes.time
36+
wikibaseintegrator.datatypes.url
37+
38+
Module contents
39+
---------------
40+
41+
.. automodule:: wikibaseintegrator.datatypes
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.sense.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.sense
2-
==================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.sense
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.sense module
2+
=========================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.sense
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/source/wikibaseintegrator.datatypes.string.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
wikibaseintegrator.datatypes.string
2-
===================================
3-
4-
.. automodule:: wikibaseintegrator.datatypes.string
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
1+
wikibaseintegrator.datatypes.string module
2+
==========================================
3+
4+
.. automodule:: wikibaseintegrator.datatypes.string
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)