Docs

seperman · Oct 4, 2023 · 8f9553f · 8f9553f
1 parent e57bb04
commit 8f9553f
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -67,11 +67,12 @@ Install optional packages:
 
 <https://zepworks.com/deepdiff/current/>
 
-# ⚡ Detect And Clean Messy Data In Transit
-
-If you deal with messy data, please check out [Qluster](https://qluster.ai/solution), another tool by [Seperman](https://github.com/seperman), the creator of DeepDiff.
-
-###### [*Qluster's mission is to enable users to create adaptive data pipelines that detect issues, quarantine bad data, and enable the user to fix data issues via a spreadsheet UI.*](https://qluster.ai)
+> # A message from Sep, the creator of DeepDiff
+>
+> 👋 Hi there,
+> If you find value in DeepDiff, you might be interested in another tool I've crafted: [Qluster](https://qluster.ai/solution). <br/>
+> As an engineer, I understand the frustration of wrestling with **unruly data** in pipelines. <br/>
+> I developed **Qluster** to empower product managers and ops teams to control and resolve data issues autonomously and **stop bugging the engineers**! 🛠️
 
 # ChangeLog
 

diff --git a/docs/authors.rst b/docs/authors.rst
@@ -83,8 +83,7 @@ Authors in order of the timeline of their contributions:
    and tomli-w for dealing with tomli files.
 -  `Alex Sauer-Budge <https://github.com/amsb>`__ for the bugfix for
    ``datetime.date``.
-- `William Jamieson <https://github.com/WilliamJamieson>`__ for `NumPy 2.0
-compatibility <https://github.com/seperman/deepdiff/pull/422>`__
+- `William Jamieson <https://github.com/WilliamJamieson>`__ for `NumPy 2.0 compatibility <https://github.com/seperman/deepdiff/pull/422>`__
 
 .. _Sep Dehpour (Seperman): http://www.zepworks.com
 .. _Victor Hahn Castell: http://hahncastell.de

diff --git a/docs/conf.py b/docs/conf.py
@@ -74,7 +74,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -124,14 +124,17 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'description': 'Get the deep difference of any Python objects',
+    'description': 'Get the deep difference of any Python objects.',
     'show_powered_by': False,
     'logo': 'logo_long_B1_black.svg',
     'logo_name': 'Zepworks DeepDiff',
     'analytics_id': 'UA-59104908-2',
     'fixed_sidebar': True,
     'extra_nav_links': {
-        'Zepworks': 'https://zepworks.com', 'Github': 'https://github.com/seperman/deepdiff'},
+        'Zepworks (Blog)': 'https://zepworks.com',
+        'Qluster (Smart ETL)': 'https://qluster.ai',
+        'Github': 'https://github.com/seperman/deepdiff'
+    },
     'show_relbars': True,
     # 'github_repo': 'deepdiff',
     'anchor': '#DDD',
@@ -219,7 +222,7 @@
 # Sphinx supports the following languages:
 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
-#html_search_language = 'en'
+html_search_language = 'en'
 
 # A dictionary with options for the search language support, empty by default.
 # Now only 'ja' uses this config value

diff --git a/docs/diff_doc.rst b/docs/diff_doc.rst
@@ -193,3 +193,10 @@ view: string, default = text
 
 int, string, unicode, dictionary, list, tuple, set, frozenset, OrderedDict, NamedTuple, Numpy, custom objects and more!
 
+.. admonition:: A message from `Sep <https://github.com/seperman>`__, the creator of DeepDiff
+
+    | 👋 Hi there,
+    | Thank you for using DeepDiff!
+    | If you find value in DeepDiff, you might be interested in another tool I've crafted: `Qluster <https://qluster.ai/solution>`__.
+    | As an engineer, I understand the frustration of wrestling with **unruly data** in pipelines.
+    | I developed Qluster to empower product managers and ops teams to control and resolve data issues autonomously and **stop bugging the engineers**! 🛠️
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -107,4 +107,15 @@ Use parse_path:
     >>> parse_path("root['joe'].age", include_actions=True)
     [{'element': 'joe', 'action': 'GET'}, {'element': 'age', 'action': 'GETATTR'}]
 
+
+---------
+
+.. admonition:: A message from `Sep <https://github.com/seperman>`__, the creator of DeepDiff
+
+    | 👋 Hi there,
+    | Thank you for using DeepDiff!
+    | If you find value in DeepDiff, you might be interested in another tool I've crafted: `Qluster <https://qluster.ai/solution>`__.
+    | As an engineer, I understand the frustration of wrestling with **unruly data** in pipelines.
+    | I developed Qluster to empower product managers and ops teams to control and resolve data issues autonomously and **stop bugging the engineers**! 🛠️
+
 Back to :doc:`/index`
diff --git a/docs/index.rst b/docs/index.rst
@@ -63,6 +63,7 @@ Tutorials
 *********
 
 Tutorials can be found on `Zepworks blog <https://zepworks.com/tags/deepdiff/>`_
+
 
 ************
 Installation
@@ -129,7 +130,6 @@ Supported data types
 int, string, unicode, dictionary, list, tuple, set, frozenset, OrderedDict, NamedTuple, Numpy, custom objects and more!
 
 
-
 References
 ==========
 

diff --git a/docs/support.rst b/docs/support.rst
@@ -3,22 +3,20 @@
 Support
 =======
 
-Hello,
+👋 Hi there,
 
-This is Sep, the creator of DeepDiff. Thanks for using DeepDiff!
-If you find a bug, please create a ticket on our `github repo`_
+Thank you for using DeepDiff!
+If you find a bug, please create a ticket on our `GitHub repo <https://github.com/seperman/deepdiff>`__
 
-Contributions to DeepDiff are always very welcome! More than `50 people </deepdiff/current/authors.html>`__ have contributed code to DeepDiff so far.
+I am **available for consulting** if you need immediate help or custom implementations of DeepDiff. You can reach me by emailing hello at this domain.
 
-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.
+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. 
 
-Please `click here <https://github.com/sponsors/seperman>`__ to read
-more about sponsoring my work.
+Please `click here <https://github.com/sponsors/seperman>`__ for sponsorship information.
 
-Thank you!
+| Lastly, you might be interested in another tool I've crafted: ⚡ `Qluster <https://qluster.ai/solution>`__.
+| As an engineer, I understand the frustration of wrestling with **unruly data** in pipelines.
+| I developed Qluster to empower product managers and ops teams to control and resolve data issues autonomously and **stop bugging the engineers**! 🛠️
 
-Sep
-
-.. _github repo: https://github.com/seperman/deepdiff
 
 Back to :doc:`/index`
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -4,18 +4,18 @@ bump2version==1.0.1
 jsonpickle==3.0.2
 coverage==6.5.0
 ipdb==0.13.13
-numpy==1.24.4
-pytest==7.4.0
+numpy==1.26.0
+pytest==7.4.2
 pytest-cov==4.1.0
 python-dotenv==0.21.0
 watchdog==2.2.0
-Sphinx==5.3.0
-sphinx-sitemap==2.2.1
+Sphinx==6.2.1  # We use the html style that is not supported in Sphinx 7 anymore.
+sphinx-sitemap==2.5.1
 sphinxemoji==0.2.0
-flake8==6.0.0
+flake8==6.1.0
 python-dateutil==2.8.2
-orjson==3.8.3
-wheel==0.38.1
-tomli==2.0.0
+orjson==3.9.7
+wheel==0.41.2
+tomli==2.0.1
 tomli-w==1.0.0
-pydantic==1.10.8
+pydantic==2.4.2