From fa6b0b743f95ae136f1c8a66a3b6916fe34f5653 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Mon, 7 Apr 2025 16:58:54 -0400 Subject: [PATCH] Update docs --- docs/source/index.rst | 23 ++++++++++++++----- docs/source/installation.rst | 10 -------- docs/source/installation/clone-repository.rst | 7 ++++++ docs/source/installation/index.rst | 8 +++++++ docs/source/supported-libraries/index.rst | 3 +++ docs/source/third-party-library-support.rst | 18 ++++++++++++--- justfile | 5 ++++ 7 files changed, 55 insertions(+), 19 deletions(-) delete mode 100644 docs/source/installation.rst create mode 100644 docs/source/installation/clone-repository.rst create mode 100644 docs/source/installation/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 61d2786..2ab55d5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,17 +2,28 @@ Django MongoDB CLI ================== -For testing Django MongoDB Backend with MongoDB's Django fork and third party libraries. - .. note:: - This documentation is for the DBX Python team and developers of third - party libraries that want to integrate their library with Django - MongoDB Backend. + This documentation is for the MongoDB DBX Python team and developers of third + party libraries that support Django MongoDB Backend. End users of + Django MongoDB Backend should refer to the + `Django MongoDB Backend documentation`_. + +This library provides the ``dm`` command line utility which can be used for: + +- Testing `Django MongoDB Backend`_ with MongoDB's `Django fork`_ and :ref:`third party libraries ` with the ``dm repo`` command. +- Testing `Django MongoDB Backend`_ projects with :ref:`third party libraries ` with the ``dm startproject`` command. + +Table of Contents +----------------- .. toctree:: :maxdepth: 2 - installation + installation/index third-party-library-support supported-libraries/index + +.. _`Django MongoDB Backend`: https://github.com/mongodb/django-mongodb-backend +.. _`Django fork`: https://github.com/mongodb-forks/django +.. _`Django MongoDB Backend documentation`: https://www.mongodb.com/docs/languages/python/django-mongodb/v5.0/ diff --git a/docs/source/installation.rst b/docs/source/installation.rst deleted file mode 100644 index 1628683..0000000 --- a/docs/source/installation.rst +++ /dev/null @@ -1,10 +0,0 @@ -Installation -============ - -:: - - git clone https://github.com/mongodb-labs/django-mongodb-cli - cd django-mongodb-cli - python -m venv .venv - source .venv/bin/activate - just install diff --git a/docs/source/installation/clone-repository.rst b/docs/source/installation/clone-repository.rst new file mode 100644 index 0000000..913d08e --- /dev/null +++ b/docs/source/installation/clone-repository.rst @@ -0,0 +1,7 @@ +Clone the repository +==================== + +:: + + git clone https://github.com/mongodb-labs/django-mongodb-cli + cd django-mongodb-cli diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst new file mode 100644 index 0000000..a4ed4cc --- /dev/null +++ b/docs/source/installation/index.rst @@ -0,0 +1,8 @@ +Installation +============ + + +.. toctree:: + clone-repository + venv + usage diff --git a/docs/source/supported-libraries/index.rst b/docs/source/supported-libraries/index.rst index 9245611..698c9f5 100644 --- a/docs/source/supported-libraries/index.rst +++ b/docs/source/supported-libraries/index.rst @@ -1,3 +1,6 @@ + +.. _third-party-libraries: + Supported libraries =================== diff --git a/docs/source/third-party-library-support.rst b/docs/source/third-party-library-support.rst index 85cdfba..9dda594 100644 --- a/docs/source/third-party-library-support.rst +++ b/docs/source/third-party-library-support.rst @@ -1,11 +1,19 @@ Third party library support =========================== +.. note:: + + This is the criteria used to determine if a third party library is supported + by Django MongoDB Backend. It is not a guarantee that the library will + work without issues, just that these criteria have been met. + Support for third party libraries is determined via the following: -- Test suites -- Project examples -- Known limitations +- :ref:`Test suites ` +- :ref:`Project examples ` +- :ref:`Known limitations ` + +.. _test_suites: Test suites ----------- @@ -36,9 +44,13 @@ For each third party library that is supported, the following tasks are performe - Replace static primary key references with dynamic references or static ``ObjectId`` references +.. _`project_examples`: + Project examples ---------------- +.. _`known_limitations`: + Known limitations ----------------- diff --git a/justfile b/justfile index 47648e4..cebb795 100644 --- a/justfile +++ b/justfile @@ -94,3 +94,8 @@ alias b := sphinx-build sphinx-serve: cd docs/_build && python -m http.server alias ss := sphinx-serve + +[group('sphinx')] +sphinx-clean: + rm -rvf docs/_build +alias sc := sphinx-clean