Skip to content

Commit 7704181

Browse files
committed
upgrade docs deps + fix inconsistencies
1 parent 889096c commit 7704181

File tree

7 files changed

+16
-38
lines changed

7 files changed

+16
-38
lines changed

docs/Makefile

+1-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,8 @@ html:
4040

4141
html-readthedocs:
4242
$(SPHINXBUILD) -T -E -b readthedocs $(ALLSPHINXOPTS) $(BUILDDIR)/html
43-
@echo
4443
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
45-
44+
@echo "Open in browser: file://`realpath $(BUILDDIR)/html/index.html`"
4645

4746
dirhtml:
4847
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

docs/django.rst

+1-14
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,4 @@ Django Support
33
==============
44

55
.. note:: Django support has been split from the main MongoEngine
6-
repository. The *legacy* Django extension may be found bundled with the
7-
0.9 release of MongoEngine.
8-
9-
10-
11-
Help Wanted!
12-
------------
13-
14-
The MongoEngine team is looking for help contributing and maintaining a new
15-
Django extension for MongoEngine! If you have Django experience and would like
16-
to help contribute to the project, please get in touch on the
17-
`mailing list <http://groups.google.com/group/mongoengine-users>`_ or by
18-
simply contributing on
19-
`GitHub <https://github.com/MongoEngine/django-mongoengine>`_.
6+
repository.

docs/guide/defining-documents.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ documents are serialized based on their field order.
2929

3030
.. _dynamic-document-schemas:
3131

32-
Dynamic document schemas
32+
Dynamic Document Schemas
3333
========================
3434
One of the benefits of MongoDB is dynamic schemas for a collection, whilst data
3535
should be planned and organised (after all explicit is better than implicit!)
@@ -260,7 +260,7 @@ document class as the first argument::
260260
comment2 = Comment(content='Nice article!')
261261
page = Page(comments=[comment1, comment2])
262262

263-
Embedded documents can also leverage the flexibility of :ref:`dynamic-document-schemas:`
263+
Embedded documents can also leverage the flexibility of :ref:`dynamic-document-schemas`
264264
by inheriting :class:`~mongoengine.DynamicEmbeddedDocument`.
265265

266266
Dictionary Fields
@@ -325,7 +325,7 @@ as the constructor's argument::
325325
.. _many-to-many-with-listfields:
326326

327327
Many to Many with ListFields
328-
'''''''''''''''''''''''''''
328+
''''''''''''''''''''''''''''
329329

330330
If you are implementing a many to many relationship via a list of references,
331331
then the references are stored as DBRefs and to query you need to pass an
@@ -492,7 +492,7 @@ The following example shows a :class:`Log` document that will be limited to
492492
meta = {'max_documents': 1000, 'max_size': 2000000}
493493

494494
Timeseries collections
495-
------------------
495+
----------------------
496496
A :class:`~mongoengine.Document` may use a **Timeseries Collection** by specifying
497497
:attr:`timeseries` in the :attr:`meta` dictionary. Timeseries collection were added
498498
in MongoDB 5.0 (`doc <https://www.mongodb.com/docs/v5.3/core/timeseries-collections/>`_).

docs/guide/migration.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ If you would remove the 'name' field or its index, you would have to call:
262262
User._get_collection().drop_index('name_1')
263263
264264
.. note:: When adding new fields or new indexes, MongoEngine will take care of creating them
265-
(unless `auto_create_index` is disabled) ::
265+
(unless `auto_create_index` is disabled)
266266

267267
Recommendations
268268
===============

docs/index.rst

+1-9
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@ MongoDB. To install it, simply run
2020
:doc:`apireference`
2121
The complete API documentation --- the innards of documents, querysets and fields.
2222

23-
:doc:`upgrade`
24-
How to upgrade MongoEngine.
25-
2623
:doc:`faq`
2724
Frequently Asked Questions
2825

@@ -58,11 +55,7 @@ pull request.
5855
Changes
5956
-------
6057

61-
See the :doc:`changelog` for a full list of changes to MongoEngine and
62-
:doc:`upgrade` for upgrade information.
63-
64-
.. note:: Always read and test the `upgrade <upgrade>`_ documentation before
65-
putting updates live in production **;)**
58+
See the :doc:`changelog` for a full list of changes to MongoEngine.
6659

6760
Offline Reading
6861
---------------
@@ -81,7 +74,6 @@ formats for offline reading.
8174
guide/index
8275
apireference
8376
changelog
84-
upgrade
8577
faq
8678
django
8779

docs/requirements.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Sphinx==3.3.0
2-
sphinx-rtd-theme==0.5.0
3-
readthedocs-sphinx-ext==2.1.1
4-
docutils==0.17.1
5-
Jinja2<3.1
1+
Sphinx==7.4.7
2+
sphinx-rtd-theme==2.1.0rc2
3+
readthedocs-sphinx-ext==2.2.5
4+
docutils==0.20.1
5+
Jinja2==3.1.4

mongoengine/base/document.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -461,13 +461,13 @@ def to_json(self, *args, **kwargs):
461461

462462
@classmethod
463463
def from_json(cls, json_data, created=False, **kwargs):
464-
"""Converts json data to a Document instance
464+
"""Converts json data to a Document instance.
465465
466-
:param str json_data: The json data to load into the Document
466+
:param str json_data: The json data to load into the Document.
467467
:param bool created: Boolean defining whether to consider the newly
468468
instantiated document as brand new or as persisted already:
469469
* If True, consider the document as brand new, no matter what data
470-
it's loaded with (i.e. even if an ID is loaded).
470+
it's loaded with (i.e., even if an ID is loaded).
471471
* If False and an ID is NOT provided, consider the document as
472472
brand new.
473473
* If False and an ID is provided, assume that the object has

0 commit comments

Comments
 (0)