Skip to content

Commit a95defa

Browse files
committed
updating docs
1 parent cb31948 commit a95defa

File tree

6 files changed

+23
-15
lines changed

6 files changed

+23
-15
lines changed

docs/conf.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
'sphinx.ext.autodoc',
3535
'sphinx.ext.doctest',
3636
'sphinx_sitemap',
37+
'sphinxemoji.sphinxemoji',
3738
]
3839

3940
# Add any paths that contain templates here, relative to this directory.
@@ -52,7 +53,7 @@
5253

5354
# General information about the project.
5455
project = 'DeepDiff'
55-
copyright = '2015-2021, Sep Dehpour'
56+
copyright = '2015-2023, Sep Dehpour'
5657
author = 'Sep Dehpour'
5758

5859
# The version info for the project you're documenting, acts as replacement for

docs/diff_doc.rst

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ DeepDiff
66
Deep Difference of dictionaries, iterables, strings and almost any other object.
77
It will recursively look for all the changes.
88

9+
.. Note::
10+
|:mega:| **Please fill out our** `fast 5-question survey <https://forms.gle/E6qXexcgjoKnSzjB8>`__ so that we can learn how & why you use DeepDiff, and what improvements we should make. Thank you! |:dancers:|
11+
912
**Parameters**
1013

1114
t1 : A dictionary, list, string or any python object that has __dict__ or __slots__
@@ -185,3 +188,4 @@ view: string, default = text
185188
**Supported data types**
186189

187190
int, string, unicode, dictionary, list, tuple, set, frozenset, OrderedDict, NamedTuple, Numpy, custom objects and more!
191+

docs/faq.rst

+3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
F.A.Q
44
=====
55

6+
.. Note::
7+
|:mega:| **Please fill out our** `fast 5-question survey <https://forms.gle/E6qXexcgjoKnSzjB8>`__ so that we can learn how & why you use DeepDiff, and what improvements we should make. Thank you! |:dancers:|
8+
69

710
Q: DeepDiff report is not precise when ignore_order=True
811
--------------------------------------------------------

docs/index.rst

+6-12
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,12 @@ DeepDiff 6-3-1
3737

3838
This release includes many bug fixes.
3939

40-
- Bugfix deephash for paths by
41-
`maggelus <https://github.com/maggelus>`__
42-
- Bugfix deephash compiled regex
43-
`maggelus <https://github.com/maggelus>`__
44-
- Fix tests dependent on toml by
45-
`martin-kokos <https://github.com/martin-kokos>`__
46-
- Bugfix for ``include_paths`` for nested dictionaries by
47-
`kor4ik <https://github.com/kor4ik>`__
48-
- Use tomli and tomli-w for dealing with tomli files by
49-
`martin-kokos <https://github.com/martin-kokos>`__
50-
- Bugfix for ``datetime.date`` by `Alex
51-
Sauer-Budge <https://github.com/amsb>`__
40+
- Bugfix deephash for paths by `maggelus <https://github.com/maggelus>`__
41+
- Bugfix deephash compiled regex `maggelus <https://github.com/maggelus>`__
42+
- Fix tests dependent on toml by `martin-kokos <https://github.com/martin-kokos>`__
43+
- Bugfix for ``include_paths`` for nested dictionaries by `kor4ik <https://github.com/kor4ik>`__
44+
- Use tomli and tomli-w for dealing with tomli files by `martin-kokos <https://github.com/martin-kokos>`__
45+
- Bugfix for ``datetime.date`` by `Alex Sauer-Budge <https://github.com/amsb>`__
5246

5347

5448
DeepDiff 6-3-0

docs/support.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,14 @@ Support
66
Hello,
77

88
This is Sep, the creator of DeepDiff. Thanks for using DeepDiff!
9-
If you find a bug please create a ticket on our `github repo`_
9+
If you find a bug, please create a ticket on our `github repo`_
1010

11-
Please note that my time is very limited for support given my other commitments so it may take a while to get back to you. In case you need direct contact for a pressing issue, I can be reached via hello at zepworks . com email address for consulting.
11+
Contributions to DeepDiff are always very welcome! More than `50 people </deepdiff/current/authors.html>`__ have contributed code to DeepDiff so far.
12+
13+
I love working on DeepDiff and other open-source projects. These projects will stay free and open source forever. If my work has been helpful to you, I would appreciate any sponsorship. Also, if you have any issue with my code that needs my immediate attention, I will be grateful for donations.
14+
15+
Please `click here <https://github.com/sponsors/seperman>`__ to read
16+
more about sponsoring my work.
1217

1318
Thank you!
1419

requirements-dev.txt

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ python-dotenv==0.21.0
1111
watchdog==2.2.0
1212
Sphinx==5.3.0
1313
sphinx-sitemap==2.2.1
14+
sphinxemoji==0.2.0
1415
flake8==6.0.0
1516
python-dateutil==2.8.2
1617
orjson==3.8.3

0 commit comments

Comments
 (0)