[DE-7207] Fix sphinx doc build errors and warnings (#453)

* Remove deprecated pkg_resources package

* Remove unsupported doc configs

* Fix Explicit markup ends without a blank line warning

* Fix toctree contains reference to nonexisting document warning

* Fix title too short warning

* Cleanup sphynx doc syntax

* Lint fixes

* Lint fixes

* Lint fix

* Isort fixes

* Use package that's compatible with older python versions

* Update poetry.lock

* Isort

* Remove deprecated poetry.dev-dependencies section

Author: edwinpav

.pylintrc

@@ -1,14 +1,12 @@
 [tool.pylint.MESSAGE_CONTROL]
 disable=
-    bad-continuation,
     no-else-return,
     no-name-in-module,
     too-few-public-methods,
     line-too-long,
     duplicate-code,
     import-error,
     unused-argument,
-    no-self-use,
     import-outside-toplevel,
     too-many-instance-attributes,
     no-member,
@@ -19,6 +17,7 @@ disable=
     C0111,
     C0103,
     R0904,
+    R0201,
     wrong-import-position
 
 [tool.pylint.REPORTS]

docs/_templates/python/module.rst

@@ -3,7 +3,7 @@
 
 {% endif %}
 {{ obj.name }}
-=============
+{{ "=" * obj.name|length }}
 
 .. py:module:: {{ obj.name }}
 

docs/conf.py

@@ -13,7 +13,7 @@
 import os
 import sys
 
-import pkg_resources
+from importlib_metadata import version as get_version
 
 sys.path.insert(0, os.path.abspath("../../"))
 
@@ -26,7 +26,7 @@
 
 
 # The full version, including alpha/beta/rc tags
-release = "v" + str(pkg_resources.get_distribution("scale-nucleus").version)
+release = "v" + get_version("scale-nucleus")
 
 
 # -- General configuration ---------------------------------------------------
@@ -68,11 +68,6 @@
 html_favicon = "favicon.ico"
 
 html_logo = "nucleus-logo.svg"
-html_theme_options = {
-    "logo_only": True,
-    "display_version": True,
-}
-
 
 # -- autogen configuration ---------------------------------------------------
 autoapi_type = "python"

docs/index.rst

@@ -13,6 +13,7 @@ Scale Nucleus helps you:
 Nucleus is a new way—the right way—to develop ML models, helping us move away from the concept of one dataset and towards a paradigm of collections of scenarios.
 
 .. _installation:
+
 Installation
 ------------
 
@@ -24,6 +25,7 @@ To use Nucleus, first install it using `pip`:
 
 
 .. _api:
+
 Sections
 --------
 

nucleus/__init__.py

@@ -182,7 +182,9 @@ def result_urls(self, wait_for_completion=True) -> List[str]:
         Returns:
             A list of signed Scale URLs which contain batches of embeddings.
 
-            The files contain a JSON array of embedding records with the following schema:
+            The files contain a JSON array of embedding records with the
+            following schema::
+
                 [{
                     "reference_id": str,
                     "embedding_vector": List[float]