Merge branch 'master' into asalikhov/community_stacks_table

.github/workflows/sphinx.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Set Up Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.x
+          python-version: "3.9"
 
       - name: Install Dev Dependencies
         run: |

Makefile

@@ -138,7 +138,7 @@ install-dev-env: ## install libraries required to build images and run tests
 
 
 docs: ## build HTML documentation
-	sphinx-build docs/ docs/_build/
+	sphinx-build -W docs/ docs/_build/
 
 install-docs-env: ## install libraries required to build docs
 	@pip install -r requirements-docs.txt

docs/conf.py

@@ -67,20 +67,21 @@ html_static_path = ["_static"]
 # sphinx-quickstart --project "docker-stacks" --author "Project Jupyter" -v "latest" -r "latest" -l en --no-sep --no-makefile --no-batchfile
 # These are custom options for this project
 
+html_theme = "sphinx_book_theme"
+html_title = "Docker Stacks documentation"
+html_logo = "_static/jupyter-logo.svg"
+html_theme_options = {
+    "path_to_docs": "docs",
+    "repository_url": "https://github.com/jupyter/docker-stacks",
+    "use_edit_page_button": True,
+    "use_issues_button": True,
+    "use_repository_button": True,
+    "use_download_button": True,
+}
+
 extensions = ["myst_parser", "sphinx_copybutton"]
 source_suffix = {
     ".rst": "restructuredtext",
     ".md": "markdown",
 }
 pygments_style = "sphinx"
-
-html_theme_options = {
-    "description": "Jupyter Docker Stacks",
-    "fixed_sidebar": False,
-    "show_relbars": True,
-    "github_user": "jupyter",
-    "github_repo": "docker-stacks",
-    "github_type": "star",
-    "logo": "jupyter-logo.svg",
-    "logo_text_align": "left",
-}

requirements-docs.txt

@@ -1,3 +1,9 @@
-myst-parser
-sphinx
-sphinx-copybutton
+# ReadTheDocs environment contains old package versions preinstalled
+# So, to ensure we have modern packages, we pin minimum versions of the packages we need
+docutils>=0.17
+myst-parser>=0.16.1
+sphinx>=4.4.0
+# TODO(asalikhov): switch to release, when it is available
+# sphinx-book-theme
+git+https://github.com/executablebooks/sphinx-book-theme@910e26be00e74cafbaaaff274de26b95cab1f7a8#egg=sphinx-book-theme
+sphinx-copybutton>=0.5.0