Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seperman committed Jul 6, 2023
1 parent cb31948 commit a95defa
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 15 deletions.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx_sitemap',
'sphinxemoji.sphinxemoji',
]

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

# General information about the project.
project = 'DeepDiff'
copyright = '2015-2021, Sep Dehpour'
copyright = '2015-2023, Sep Dehpour'
author = 'Sep Dehpour'

# The version info for the project you're documenting, acts as replacement for
Expand Down
4 changes: 4 additions & 0 deletions docs/diff_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ DeepDiff
Deep Difference of dictionaries, iterables, strings and almost any other object.
It will recursively look for all the changes.

.. Note::
|: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:|

**Parameters**

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

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

3 changes: 3 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
F.A.Q
=====

.. Note::
|: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:|


Q: DeepDiff report is not precise when ignore_order=True
--------------------------------------------------------
Expand Down
18 changes: 6 additions & 12 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,12 @@ DeepDiff 6-3-1

This release includes many bug fixes.

- Bugfix deephash for paths by
`maggelus <https://github.com/maggelus>`__
- Bugfix deephash compiled regex
`maggelus <https://github.com/maggelus>`__
- Fix tests dependent on toml by
`martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``include_paths`` for nested dictionaries by
`kor4ik <https://github.com/kor4ik>`__
- Use tomli and tomli-w for dealing with tomli files by
`martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``datetime.date`` by `Alex
Sauer-Budge <https://github.com/amsb>`__
- Bugfix deephash for paths by `maggelus <https://github.com/maggelus>`__
- Bugfix deephash compiled regex `maggelus <https://github.com/maggelus>`__
- Fix tests dependent on toml by `martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``include_paths`` for nested dictionaries by `kor4ik <https://github.com/kor4ik>`__
- Use tomli and tomli-w for dealing with tomli files by `martin-kokos <https://github.com/martin-kokos>`__
- Bugfix for ``datetime.date`` by `Alex Sauer-Budge <https://github.com/amsb>`__


DeepDiff 6-3-0
Expand Down
9 changes: 7 additions & 2 deletions docs/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ Support
Hello,

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

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.
Contributions to DeepDiff are always very welcome! More than `50 people </deepdiff/current/authors.html>`__ have contributed code to DeepDiff so far.

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.

Please `click here <https://github.com/sponsors/seperman>`__ to read
more about sponsoring my work.

Thank you!

Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ python-dotenv==0.21.0
watchdog==2.2.0
Sphinx==5.3.0
sphinx-sitemap==2.2.1
sphinxemoji==0.2.0
flake8==6.0.0
python-dateutil==2.8.2
orjson==3.8.3
Expand Down

0 comments on commit a95defa

Please sign in to comment.