Skip to content

INTPYTHON-228 & INTPYTHON-464 Include data types in API docs and add API docs to landing page #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 26, 2025
Merged

INTPYTHON-228 & INTPYTHON-464 Include data types in API docs and add API docs to landing page #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions bindings/python/docs/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ Sub-modules:

api
monkey
pandas_types
types
7 changes: 7 additions & 0 deletions bindings/python/docs/source/api/pandas_types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:mod:`pandas_types` -- Pandas Extension Types
=============================================

.. automodule:: pymongoarrow.pandas_types
:synopsis: Pandas Extension Types for PyMongoArrow
:members:
:inherited-members:
7 changes: 7 additions & 0 deletions bindings/python/docs/source/api/types.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:mod:`types` -- PyArrow Extension Types
=======================================

.. automodule:: pymongoarrow.types
:synopsis: PyArrow Extension Types for PyMongoArrow
:members:
:inherited-members:
6 changes: 6 additions & 0 deletions bindings/python/docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
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/>`__.


.. toctree::
:maxdepth: 2

api/index
2 changes: 1 addition & 1 deletion bindings/python/tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ setenv =
deps =
-rdocs/docs-requirements.txt
commands =
python -m sphinx -q -E -W -b html source {envtmpdir}/html {posargs}
python -m sphinx -q -E -b html source {envtmpdir}/html {posargs}

[testenv:docs-serve]
description = serve sphinx docs
Expand Down
Loading