Skip to content

Commit c69b84a

Browse files
LeMystLeMyst
authored
Update the documentation (#823)
1 parent 9370586 commit c69b84a

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‎

Lines changed: 5 additions & 0 deletions
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‎

Lines changed: 7 additions & 7 deletions
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‎

Lines changed: 7 additions & 7 deletions
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‎

Lines changed: 7 additions & 7 deletions
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‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 7 additions & 7 deletions
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‎

Lines changed: 7 additions & 7 deletions
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‎

Lines changed: 7 additions & 7 deletions
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‎

Lines changed: 19 additions & 9 deletions
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‎

Lines changed: 7 additions & 7 deletions
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:

0 commit comments

Comments
 (0)