Add conda-sphinx-theme to conda-build main

docs/requirements.txt

@@ -1,3 +1,4 @@
+conda-sphinx-theme==0.1.1
 linkify-it-py==2.0.2
 myst-parser==2.0.0
 Pillow==10.0.1
@@ -7,8 +8,8 @@ ruamel.yaml==0.17.32
 Sphinx==7.2.6
 sphinx-argparse==0.4.0
 sphinx-autobuild==2021.3.14
-sphinx-rtd-theme==1.3.0
 sphinx-sitemap==2.5.1
+sphinx_design==0.5.0
 sphinxcontrib-applehelp==1.0.7
 sphinxcontrib-devhelp==1.0.5
 sphinxcontrib-htmlhelp==2.0.4

docs/source/concepts/package-naming-conv.rst

@@ -3,33 +3,35 @@ Package naming conventions
 ==========================
 
 To facilitate communication and documentation, conda observes the
-package naming conventions listed below.
-
-**Package name**
-    The name of a package, without any reference to a particular
-    version. Conda package names are normalized and they may contain
-    only lowercase alpha characters, numeric digits, underscores,
-    hyphens, or dots. In usage documentation, these are referred to
-    by ``package_name``.
-
-**Package version**
-    A version number or string, often similar to ``X.Y`` or
-    ``X.Y.Z``, but it may take other forms as well.
-
-**Build string**
-    An arbitrary string that identifies a particular build of a
-    package for conda. It may contain suggestive mnemonics, but
-    these are subject to change, and you should not rely on it or try
-    to parse it for any specific information.
-
-**Canonical name**
-    The package name, version, and build string joined together by
-    hyphens: name-version-buildstring. In usage documentation, these
-    are referred to by ``canonical_name``.
-
-**Filename**
-    Conda package filenames are canonical names, plus the suffix
-    ``.tar.bz2`` or ``.conda``.
+package naming conventions listed below:
+
+.. glossary::
+
+    Package name
+        The name of a package, without any reference to a particular
+        version. Conda package names are normalized and they may contain
+        only lowercase alpha characters, numeric digits, underscores,
+        hyphens, or dots. In usage documentation, these are referred to
+        by ``package_name``.
+
+    Package version
+        A version number or string, often similar to ``X.Y`` or
+        ``X.Y.Z``, but it may take other forms as well.
+
+    Build string
+        An arbitrary string that identifies a particular build of a
+        package for conda. It may contain suggestive mnemonics, but
+        these are subject to change, and you should not rely on it or try
+        to parse it for any specific information.
+
+    Canonical name
+        The package name, version, and build string joined together by
+        hyphens: name-version-buildstring. In usage documentation, these
+        are referred to by ``canonical_name``.
+
+    Filename
+        Conda package filenames are canonical names, plus the suffix
+        ``.tar.bz2`` or ``.conda``.
 
 The following figure compares a canonical name to a filename:
 

docs/source/concepts/recipe.rst

@@ -2,10 +2,6 @@
 Conda-build recipes
 ===================
 
-.. contents::
-   :local:
-   :depth: 2
-
 To enable building `conda packages`_, :ref:`install and update conda
 and conda-build <install-conda-build>`.
 

docs/source/conf.py

@@ -50,6 +50,7 @@
     "sphinx.ext.todo",
     "sphinx.ext.coverage",
     "sphinx_sitemap",
+    "sphinx_design",
 ]
 
 myst_heading_anchors = 3
@@ -104,23 +105,60 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "conda_sphinx_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    # The maximum depth of the table of contents tree. Set this to -1 to allow
+    # unlimited depth.
+    "navigation_depth": -1,
+    "show_prev_next": False,
+    # Navbar icon links
+    "navbar_start": ["navbar-logo"],
+    "use_edit_page_button": True,
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/conda/conda-build",
+            "icon": "fa-brands fa-square-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "Element",
+            "url": "https://matrix.to/#/#conda-build:matrix.org",
+            "icon": "_static/element_logo.svg",
+            "type": "local",
+        },
+        {
+            "name": "Discourse",
+            "url": "https://conda.discourse.group/",
+            "icon": "fa-brands fa-discourse",
+            "type": "fontawesome",
+        },
+    ],
+}
+
+html_context = {
+    "github_user": "conda",
+    "github_repo": "conda-build",
+    "github_version": "main",
+    "doc_path": "docs/source",
+}
 
 html_short_title = "conda-build"
-html_show_sourcelink = False
-html_favicon = "conda-logo.png"
+# html_show_sourcelink = False
 html_extra_path = ["robots.txt"]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
+
+# Custom CSS rules
+# html_style = "css/custom.css"
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -212,5 +250,3 @@
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
-
-html_style = "css/custom.css"

docs/source/index.rst

@@ -1,5 +1,3 @@
-.. _index:
-
 Conda-build documentation
 =========================
 

docs/source/resources/define-metadata.rst

@@ -4,11 +4,6 @@
 Defining metadata (meta.yaml)
 =============================
 
-.. contents::
-   :local:
-   :depth: 1
-
-
 All the metadata in the conda-build recipe is specified in the
 ``meta.yaml`` file. See the example below:
 

docs/source/resources/package-spec.rst

@@ -2,10 +2,6 @@
 Conda package specification
 ===========================
 
-.. contents::
-   :local:
-   :depth: 1
-
 A conda package is an archive file that contains:
 
 * Metadata under the ``info/`` directory.

docs/source/resources/tutorial-template.rst

@@ -2,10 +2,6 @@
 Tutorial template
 =================
 
-.. contents::
-   :local:
-   :depth: 1
-
 .. [email protected]: [email protected]
 
 *This document describes the steps for creating*

docs/source/user-guide/environment-variables.rst

@@ -4,10 +4,6 @@
 Environment variables
 =====================
 
-.. contents::
-   :local:
-   :depth: 1
-
 .. _build-state:
 
 Dynamic behavior based on state of build process

docs/source/user-guide/index.rst

@@ -17,26 +17,30 @@ variables and wheel files.
    wheel-files
 
 
-**Tutorials**
+Tutorials
+.........
 
 The :doc:`tutorials <../user-guide/tutorials/index>` will guide you through
 how to build conda packages — whether you're creating a
 package with compilers, using conda skeleton, creating from
 scratch, or building R packages using skeleton CRAN.
 
-**Recipes**
+Recipes
+.......
 
 Conda-build uses :doc:`recipes <../user-guide/recipes/index>` to create conda packages.
 We have guides on debugging conda recipes, sample recipes for you to use, and
 information on how to build a package without a recipe.
 
-**Environment variables**
+Environment variables
+.....................
 
 Use our :doc:`environment variables <environment-variables>` guide
 to understand which environment variables are available, set,
 and inherited, and how they affect different processes.
 
-**Wheel files**
+Wheel files
+...........
 
 The user guide includes information about
 :doc:`wheel files <wheel-files>` and how to build conda

docs/source/user-guide/recipes/build-without-recipe.rst

@@ -2,11 +2,6 @@
 Building a package without a recipe (bdist_conda)
 =================================================
 
-.. contents::
-   :local:
-   :depth: 2
-
-
 You can use conda-build to build packages for Python to install
 rather than conda by using ``setup.py bdist_conda``. This is a
 quick way to build packages without using a recipe, but it has

docs/source/user-guide/tutorials/build-pkgs-skeleton.rst

@@ -2,11 +2,6 @@
 Building conda packages with conda skeleton
 ===========================================
 
-
-.. contents::
-   :local:
-   :depth: 1
-
 Overview
 ========
 

docs/source/user-guide/tutorials/build-pkgs.rst

@@ -2,11 +2,6 @@
 Building conda packages from scratch
 ====================================
 
-
-.. contents::
-   :local:
-   :depth: 1
-
 Overview
 ========
 

docs/source/user-guide/tutorials/build-r-pkgs.rst

@@ -2,10 +2,6 @@
 Building R packages with skeleton CRAN
 ======================================
 
-.. contents::
-   :local:
-   :depth: 1
-
 Overview
 ========