Skip to content

Commit 9bbbed7

Browse files
authored
INTPYTHON-228 & INTPYTHON-464 Include data types in API docs and add API docs to landing page (#279)
1 parent ac279ad commit 9bbbed7

File tree

5 files changed

+23
-1
lines changed

5 files changed

+23
-1
lines changed

bindings/python/docs/source/api/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Sub-modules:
1313

1414
api
1515
monkey
16+
pandas_types
17+
types
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:mod:`pandas_types` -- Pandas Extension Types
2+
=============================================
3+
4+
.. automodule:: pymongoarrow.pandas_types
5+
:synopsis: Pandas Extension Types for PyMongoArrow
6+
:members:
7+
:inherited-members:
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:mod:`types` -- PyArrow Extension Types
2+
=======================================
3+
4+
.. automodule:: pymongoarrow.types
5+
:synopsis: PyArrow Extension Types for PyMongoArrow
6+
:members:
7+
:inherited-members:

bindings/python/docs/source/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
11
The PyMongoArrow documentation has moved. For documentation for v1.3 and later, see `MongoDB PyMongoArrow <https://www.mongodb.com/docs/languages/python/pymongo-arrow-driver/current/>`__.
2+
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
api/index

bindings/python/tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ setenv =
8484
deps =
8585
-rdocs/docs-requirements.txt
8686
commands =
87-
python -m sphinx -q -E -W -b html source {envtmpdir}/html {posargs}
87+
python -m sphinx -q -E -b html source {envtmpdir}/html {posargs}
8888

8989
[testenv:docs-serve]
9090
description = serve sphinx docs

0 commit comments

Comments
 (0)