Fix displayed version in documentation. (#135)

Author: tobiasraabe

CITATION

@@ -1,6 +1,6 @@
 @Unpublished{Raabe2020,
-Title  = {A Python tool for managing scientific workflows.},
-Author = {Tobias Raabe},
-Year   = {2020},
-Url    = {https://github.com/pytask-dev/pytask}
+    Title  = {A Python tool for managing scientific workflows.},
+    Author = {Tobias Raabe},
+    Year   = {2020},
+    Url    = {https://github.com/pytask-dev/pytask}
 }

README.rst

@@ -68,11 +68,12 @@ projects. Its features include:
 
 - **Easily extensible with plugins**. pytask's architecture is based on `pluggy
   <https://pluggy.readthedocs.io/en/latest/>`_, a plugin management framework, so that
-  you can adjust pytask to your needs. Plugins are, for example, available for
-  `parallelization <https://github.com/pytask-dev/pytask-parallel>`_, `LaTeX
+  you can adjust pytask to your needs. Plugins are available for `parallelization
+  <https://github.com/pytask-dev/pytask-parallel>`_, `LaTeX
   <https://github.com/pytask-dev/pytask-latex>`_, `R
   <https://github.com/pytask-dev/pytask-r>`_, and `Stata
-  <https://github.com/pytask-dev/pytask-stata>`_. Read `here
+  <https://github.com/pytask-dev/pytask-stata>`_ and `many more
+  <https://github.com/topics/pytask>`_. Read `here
   <https://pytask-dev.readthedocs.io/en/latest/tutorials/how_to_use_plugins.html>`_ how
   you can use plugins.
 
@@ -92,7 +93,9 @@ the package with
 
     $ pip install pytask
 
-    # or
+or
+
+.. code-block:: console
 
     $ conda install -c conda-forge pytask
 

docs/source/changes.rst

@@ -10,6 +10,7 @@ all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
 0.1.2 - 2021-xx-xx
 ------------------
 
+- :gh:`135` implements handling of version in docs as proposed by setuptools-scm.
 - :gh:`142` removes the display of skipped and persisted tasks from the live execution
   table for the default verbosity level of 1. They are displayed at 2.
 - :gh:`144` adds tryceratops to the pre-commit hooks for catching issues with

docs/source/conf.py

@@ -6,9 +6,9 @@
 # these directories to sys.path here. If the directory is relative to the documentation
 # root, use os.path.abspath to make it absolute, like shown here.
 import datetime as dt
+from importlib.metadata import version
 
 import sphinx
-from pkg_resources import get_distribution
 
 
 # -- Project information ---------------------------------------------------------------
@@ -19,9 +19,9 @@
 copyright = f"2020-{year}, {author}"  # noqa: A001
 
 # The version, including alpha/beta/rc tags, but not commit hash and datestamps
-release = get_distribution("pytask").version.split("+")[0]
+release = version("pytask")
 # The short X.Y version.
-version = release
+version = ".".join(release.split(".")[:2])
 
 # -- General configuration -------------------------------------------------------------
 
@@ -80,8 +80,8 @@
 }
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.8", None),
-    "click": ("https://click.palletsprojects.com/en/7.x", None),
+    "python": ("https://docs.python.org/3.9", None),
+    "click": ("https://click.palletsprojects.com/en/8.0.x/", None),
     "pluggy": ("https://pluggy.readthedocs.io/en/latest", None),
 }
 

setup.py

@@ -1,4 +1,5 @@
 from setuptools import setup
 
+
 if __name__ == "__main__":
     setup()