[issue-571] sphinx errors fixes (deepchecks#688)

* docs links fix



Co-authored-by: Yuriy Romanyshyn <[email protected]>

docs/.lycheeignore

@@ -16,3 +16,4 @@
 
 # other
 ^https://www\.linkedin\.com/in/rohith-ramakrishnan-54094a1a0.*$
+^.*examples/guides/\\.*$

docs/source/conf.py

@@ -67,6 +67,7 @@
     'sphinx_copybutton',
     'sphinx.ext.githubpages',
     'sphinx_search.extension',
+    'sphinx.ext.autosectionlabel',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -493,3 +494,8 @@ def add_custom_routines(app, pagename, templatename, context, doctree):
     app.config.generate_binder_url = generate_binder_url
     app.config.generate_colab_url = generate_colab_url
     app.config.get_check_example_api_reference = get_check_example_api_reference
+
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

docs/source/examples/guides/create_a_custom_suite.ipynb

@@ -39,7 +39,7 @@
     "For assistance in understanding which checks are implemented and can be included, we suggest using any of:\n",
     "\n",
     "- [API Reference](../../api/index.rst)\n",
-    "- [Check demonstration notebooks](../checks/index.rst)\n",
+    "- [Check demonstration notebooks](../index.rst#Check-Demonstrations)\n",
     "- Built-in suites (by printing them to see which checks they include)"
    ]
   },

docs/source/user-guide/dataset_object.rst

@@ -160,7 +160,7 @@ will run on the columns to determine which are classified as categorical:
    - If (`number of unique values in column` <= `max_float_categories`) 
      **AND** (`column type` is `float`)
 
-   - If (`number of unique values in column` <= ``max_categories`)  
+   - If (`number of unique values in column` <= `max_categories`)  
      **AND** ((the ratio between the `number of unique values` and the `number of samples`) < `max_categorical_ratio`)
 
 Check the API Reference for :doc:`infer_categorical_features </api/utils/generated/deepchecks.utils.features.infer_categorical_features>` 

docs/source/user-guide/key_concepts.rst

@@ -5,7 +5,7 @@ Key Concepts
 A Suite runs a collection of Checks with optional Conditions added to them.
 
 Check
-========
+^^^^^
 
 Each check enables you to inspect a specific aspect of your data and
 models. They are the basic building block of the deepchecks package,
@@ -22,16 +22,17 @@ Each check can have two types of results:
    results (validations are typically done by adding a "Condition" to
    the check, as explained below).
 
+
 See Also
 ---------
 
-- :doc:`Check Demonstrations </examples/checks/index>` - example notebooks demonstrating all of the checks implemented in the package.
+- :ref:`Check Demonstrations` - example notebooks demonstrating all of the checks implemented in the package.
 - :doc:`Checks API Reference </api/checks>` - where all the check parameters and implemented conditions can be found.
 - :doc:`/examples/guides/add_a_custom_check` - for a tutorial of how to implement your own check
 
 
 Condition
-==========
+^^^^^^^^^
 
 A condition is a function that can be added to a Check, which returns
 a pass ✓, fail ✖ or warning ! result, intended for validating the Check's return value.
@@ -51,11 +52,11 @@ See Also
 ---------
 
 - :doc:`/examples/guides/configure_check_conditions` - for a tutorial demonstrating how to modify a checks' conditions
-- :doc:`Check Base Classes API Reference </api/base/generated/deepchecks.base.check>` - where all of the check and condition related base objects can be found. 
+- :doc:`Check Base Classes API Reference </api/base>` - where all of the check and condition related base objects can be found. 
 
 
 Suite
-========
+^^^^^
 
 An ordered collection of checks, that can have conditions added to them.
 The Suite enables displaying a concluding report for all of the Checks