diff --git a/dev-requirements.txt b/dev-requirements.txt index 5602cfb..ac0bfae 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -2,10 +2,10 @@ flake8 # Static type checking -mypy==0.910 +mypy==0.942 # Automatic code formatting -black==21.11b1 +black==22.3.0 isort==5.10.1 # Running tests @@ -24,16 +24,16 @@ setuptools wheel # Building docs -Sphinx==4.3.0 +Sphinx==4.5.0 # Sphinx theme: https://sphinx-themes.org/sample-sites/furo/ -furo==2021.11.23 +furo==2022.3.4 # Lets Sphinx parse markdown files in addition to rst. -myst-parser==0.15.2 +myst-parser==0.17.0 # Adds a copy button to code examples in the docs. -sphinx-copybutton==0.4.0 +sphinx-copybutton==0.5.0 # Live rebuilding and reloading of docs for developing locally. sphinx-autobuild==2021.3.14 diff --git a/docs/source/conf.py b/docs/source/conf.py index 3d53d1d..60588ee 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -4,15 +4,16 @@ # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import os +import sys +from datetime import datetime + # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add 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 os -import sys - sys.path.insert(0, os.path.abspath("../../")) from beaker.version import VERSION, VERSION_SHORT # noqa: E402 @@ -20,7 +21,7 @@ # -- Project information ----------------------------------------------------- project = "beaker-py" -copyright = "2021, Allen Institute for Artificial Intelligence" +copyright = f"{datetime.today().year}, Allen Institute for Artificial Intelligence" author = "Allen Institute for Artificial Intelligence" version = VERSION_SHORT release = VERSION @@ -39,6 +40,11 @@ "sphinx.ext.viewcode", ] +# Tell myst-parser to assign header anchors for h1-h3. +myst_heading_anchors = 3 + +suppress_warnings = ["myst.header"] + # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/docs/source/index.rst b/docs/source/index.rst index e35cab4..e759af0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,12 +16,12 @@ Contents installation quickstart api - CHANGELOG .. toctree:: :hidden: :caption: Development + CHANGELOG License CONTRIBUTING GitHub Repository