documenteer 1.2.2__tar.gz → 1.3.0__tar.gz

{documenteer-1.2.2 → documenteer-1.3.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-yaml
         exclude: ^src/documenteer/storage/localtemplates/technote/ci\.yaml
@@ -22,12 +22,12 @@ repos:
           - toml
 
   - repo: https://github.com/psf/black
-    rev: 24.3.0
+    rev: 24.4.2
     hooks:
       - id: black
 
   - repo: https://github.com/asottile/blacken-docs
-    rev: 1.14.0
+    rev: 1.16.0
     hooks:
       - id: blacken-docs
         additional_dependencies: [black==22.12.0]

{documenteer-1.2.2 → documenteer-1.3.0}/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-1.3.0'></a>
+## 1.3.0 (2024-05-03)
+
+### New features
+
+- Added a `[sphinx.redirects]` table to `documenteer.toml`. This provides support for configuring page redirects from the TOML configuratin. Redirects are useful if pages move because of a content re-organization. This feature is based on [sphinx-rediraffe](https://github.com/wpilibsuite/sphinxext-rediraffe).
+
+- Added the [sphinxcontrib-youtube](https://sphinxcontrib-youtube.readthedocs.io/en/latest/index.html) for embedded YouTube and Vimeo videos into documentation pages. This extension is available for both user guides (`documenteer.conf.guide`) and technotes (`documenteer.conf.technotes`).
+
+### Bug fixes
+
+- Technotes ignore files in the repository with `.md`, `.rst`, and `.ipynb` extensions if they aren't the index file. Since technotes are single-page documents, only the index file should be used as a source file. This change lets authors include auxiliary notebooks with their technotes without having to explicitly exclude them from the technote build process. This is implemented with `technote.conf.extend_excludes_for_non_index_source`.
+
+- In `documenteer.ext.lssttasks`, attempt to import `_pseudo_parse_arglist` from `sphinx.domains.python._annotations` before falling back to the `sphinx.domains.python` module. Ultimately this is a workaround.
+
+- Fix setting the rebuild condition for the `documenteer.ext.githubbibcache` extension.
+
+- Fixed the monospace text baseline alignment issue in Safari for technotes by updating to technote 0.8.0. In this version, the font size of the code is set to be 0.9em so that the browser doesn't push the text below the baseline in case its larger than the Source Sans body text. This version also changes the font size on the html element to 100% and instead increases the baseline body text size to 1.1rem on the body element. This change should help technotes respect the user's browser font size settings while also making the rem unit work as expected.
+
+### Other changes
+
+- Added `defusedxml` as a dev dependency. This is used by Sphinx's `sphinx.testing.fixtures`, but isn't included as a dependency by Sphinx itself. This change ensures that `defusedxml` is installed when running the tests.
+
 <a id='changelog-1.2.2'></a>
 ## 1.2.2 (2024-04-11)
 

{documenteer-1.2.2 → documenteer-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: documenteer
-Version: 1.2.2
+Version: 1.3.0
 Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
 License: The MIT License (MIT)
         
@@ -61,6 +61,7 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: lxml; extra == "dev"
 Requires-Dist: cssselect; extra == "dev"
+Requires-Dist: defusedxml; extra == "dev"
 Requires-Dist: sphinx-click; extra == "dev"
 Requires-Dist: sphinxcontrib-autoprogram; extra == "dev"
 Requires-Dist: types-setuptools; extra == "dev"
@@ -84,6 +85,7 @@ Requires-Dist: sphinxext-opengraph; extra == "guide"
 Requires-Dist: sphinxcontrib-redoc; extra == "guide"
 Requires-Dist: sphinxcontrib-jquery; extra == "guide"
 Requires-Dist: sphinxext-rediraffe; extra == "guide"
+Requires-Dist: sphinxcontrib-youtube; extra == "guide"
 Provides-Extra: pipelines
 Requires-Dist: sphinx_design; extra == "pipelines"
 Requires-Dist: pydata-sphinx-theme<0.13.0,>=0.10.0; extra == "pipelines"
@@ -102,12 +104,13 @@ Requires-Dist: sphinxcontrib-autoprogram; extra == "pipelines"
 Requires-Dist: sphinxcontrib-doxylink; extra == "pipelines"
 Requires-Dist: sphinx-click; extra == "pipelines"
 Provides-Extra: technote
-Requires-Dist: technote<0.8.0,>=0.7.0; extra == "technote"
+Requires-Dist: technote<0.9.0,>=0.8.0; extra == "technote"
 Requires-Dist: sphinx-prompt; extra == "technote"
 Requires-Dist: sphinxcontrib-mermaid; extra == "technote"
 Requires-Dist: sphinx-diagrams; extra == "technote"
 Requires-Dist: sphinx_design; extra == "technote"
 Requires-Dist: myst-nb; extra == "technote"
+Requires-Dist: sphinxcontrib-youtube; extra == "technote"
 
 [![Documentation](https://img.shields.io/badge/documenteer-lsst.io-brightgreen.svg)](https://documenteer.lsst.io)
 [![PyPI](https://img.shields.io/pypi/v/documenteer.svg?style=flat-square)](https://pypi.python.org/pypi/documenteer)

documenteer-1.3.0/demo/ipynb-technote/index.ipynb

@@ -0,0 +1,97 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Demo technote\n",
+    "\n",
+    "```{abstract}\n",
+    "A *technote* is a web-native single page document that enables rapid technical communication within and across teams.\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Introduction\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Method\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "A list:\n",
+    "\n",
+    "- First item\n",
+    "- Second item\n",
+    "- Third item\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(\"Hello world\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Analysis\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "```{prompt} bash\n",
+    "git add index.rst\n",
+    "```\n",
+    "\n",
+    "Some following text.\n",
+    "\n",
+    "```{mermaid}\n",
+    "graph TD\n",
+    "    A[Square Rect] -- Link text --> B((Circle))\n",
+    "    A --> C(Round Rect)\n",
+    "    B --> D{Rhombus}\n",
+    "    C --> D\n",
+    "```\n",
+    "\n",
+    "```{diagrams} diagram.py\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## References\n",
+    "\n",
+    "```{bibliography}\n",
+    "```"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

documenteer-1.3.0/demo/ipynb-technote/subdir/subdir-notebook.ipynb

@@ -0,0 +1,97 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Demo technote\n",
+    "\n",
+    "```{abstract}\n",
+    "A *technote* is a web-native single page document that enables rapid technical communication within and across teams.\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Introduction\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "A parenthetical citation {cite:p}`SQR-083`. And a textual citation {cite:t}`SQR-083`."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Method\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "A list:\n",
+    "\n",
+    "- First item\n",
+    "- Second item\n",
+    "- Third item\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(\"Hello world\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Analysis\n",
+    "\n",
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.\n",
+    "\n",
+    "```{prompt} bash\n",
+    "git add index.rst\n",
+    "```\n",
+    "\n",
+    "Some following text.\n",
+    "\n",
+    "```{mermaid}\n",
+    "graph TD\n",
+    "    A[Square Rect] -- Link text --> B((Circle))\n",
+    "    A --> C(Round Rect)\n",
+    "    B --> D{Rhombus}\n",
+    "    C --> D\n",
+    "```\n",
+    "\n",
+    "```{diagrams} diagram.py\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## References\n",
+    "\n",
+    "```{bibliography}\n",
+    "```"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

{documenteer-1.2.2 → documenteer-1.3.0}/demo/rst-technote/index.rst

@@ -16,7 +16,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetr
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
 
-A parenthetical citation :cite:p:`SQR-083`. And a textual citation :cite:t:`SQR-083`.
+A parenthetical citation :cite:p:`SQR-083`. And a textual citation :cite:t:`SQR-083`. Some ``source code`` embedded in text.
 
 Method
 ======

{documenteer-1.2.2 → documenteer-1.3.0}/docs/changelog.md

@@ -2,6 +2,29 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-1.3.0'></a>
+## 1.3.0 (2024-05-03)
+
+### New features
+
+- Added a `[sphinx.redirects]` table to `documenteer.toml`. This provides support for configuring page redirects from the TOML configuratin. Redirects are useful if pages move because of a content re-organization. This feature is based on [sphinx-rediraffe](https://github.com/wpilibsuite/sphinxext-rediraffe).
+
+- Added the [sphinxcontrib-youtube](https://sphinxcontrib-youtube.readthedocs.io/en/latest/index.html) for embedded YouTube and Vimeo videos into documentation pages. This extension is available for both user guides (`documenteer.conf.guide`) and technotes (`documenteer.conf.technotes`).
+
+### Bug fixes
+
+- Technotes ignore files in the repository with `.md`, `.rst`, and `.ipynb` extensions if they aren't the index file. Since technotes are single-page documents, only the index file should be used as a source file. This change lets authors include auxiliary notebooks with their technotes without having to explicitly exclude them from the technote build process. This is implemented with `technote.conf.extend_excludes_for_non_index_source`.
+
+- In `documenteer.ext.lssttasks`, attempt to import `_pseudo_parse_arglist` from `sphinx.domains.python._annotations` before falling back to the `sphinx.domains.python` module. Ultimately this is a workaround.
+
+- Fix setting the rebuild condition for the `documenteer.ext.githubbibcache` extension.
+
+- Fixed the monospace text baseline alignment issue in Safari for technotes by updating to technote 0.8.0. In this version, the font size of the code is set to be 0.9em so that the browser doesn't push the text below the baseline in case its larger than the Source Sans body text. This version also changes the font size on the html element to 100% and instead increases the baseline body text size to 1.1rem on the body element. This change should help technotes respect the user's browser font size settings while also making the rem unit work as expected.
+
+### Other changes
+
+- Added `defusedxml` as a dev dependency. This is used by Sphinx's `sphinx.testing.fixtures`, but isn't included as a dependency by Sphinx itself. This change ensures that `defusedxml` is installed when running the tests.
+
 <a id='changelog-1.2.2'></a>
 ## 1.2.2 (2024-04-11)
 

documenteer-1.3.0/docs/conf.py

@@ -0,0 +1,3 @@
+# See the documenteer.toml for overrides of the Rubin user guide presets
+
+from documenteer.conf.guide import *  # noqa: F403

{documenteer-1.2.2 → documenteer-1.3.0}/docs/documenteer.toml

@@ -44,3 +44,12 @@ technote = "https://technote.lsst.io/"
 ignore = [
     "https://mermaid-js.github.io"
 ]
+
+[sphinx.redirects]
+"pipelines/build-overview.rst" = "guides/pipelines/build-overview.rst"
+"pipelines/configuration.rst" = "guides/pipelines/configuration.rst"
+"pipelines/cpp-api-linking.rst" = "guides/pipelines/cpp-api-linking.rst"
+"pipelines/index.rst" = "guides/pipelines/index.rst"
+"pipelines/install.rst" = "guides/pipelines/install.rst"
+"pipelines/package-docs-cli.rst" = "guides/pipelines/package-docs-cli.rst"
+"pipelines/stack-docs-cli.rst" = "guides/pipelines/stack-docs-cli.rst"

{documenteer-1.2.2 → documenteer-1.3.0}/docs/guides/index.rst

@@ -26,6 +26,7 @@ Documenteer provides a configuration profile for creating branded user guides wi
    pyproject-configuration
    openapi
    rst-epilog
+   page-redirects
    extend-conf-py
 
 .. toctree::
@@ -36,6 +37,7 @@ Documenteer provides a configuration profile for creating branded user guides wi
    diagrams
    badges
    tabsets
+   video-embeds
 
 .. toctree::
    :maxdepth: 2

documenteer-1.3.0/docs/guides/page-redirects.rst

@@ -0,0 +1,42 @@
+###########################################
+Redirecting pages when reorganizing content
+###########################################
+
+As a documentation site grows, its natural for content to need to move.
+If pages are moved or renamed, you should create a redirect from the old page path to the new one so that users won't be orphaned by out-of-date links and bookmarks.
+Documenteer supports this with the :ref:`guide-sphinx-redirects` table in the :file:`documenteer.toml` configuration file.
+
+Adding a page redirect in documenteer.toml
+==========================================
+
+As an example, consider the page at :file:`old-page.rst` has moved to :file:`some-dir/new-page.rst`.
+To create a redirect from the old page to the new one, add the following to the :file:`documenteer.toml` file:
+
+.. code-block:: toml
+   :caption: documenteer.toml
+
+   [sphinx.redirects]
+   "old-page.rst" = "some-dir/new-page.rst"
+
+These paths are relative to the documentation project's root directory (where :file:`conf.py` and :guide:`documenteer.toml` are located) and include the file extension (e.g., :file:`.rst` or :file:`.md`).
+
+The table accepts an arbitrary number of redirects:
+
+.. code-block:: toml
+   :captin: documenteer.toml
+
+   [sphinx.redirects]
+   "old-page.rst" = "some-dir/new-page.rst"
+   "foo.rst" = "bar.rst"
+
+Redirects for deleted pages
+===========================
+
+Besides pages that have been moved, you can use this feature for pages that have been deleted.
+Choose an existing path that is most relevant to the deleted page and redirect it to the new location.
+
+.. code-block:: toml
+   :caption: documenteer.toml
+
+   [sphinx.redirects]
+   "deleted-page.rst" = "index.rst"

{documenteer-1.2.2 → documenteer-1.3.0}/docs/guides/toml-reference.rst

@@ -372,10 +372,27 @@ The default value is ``api``, which is a good standard for Python projects with
 If the Python API is oriented towards contributors, such as in an application or service, you can change the default:
 
 .. code-block:: toml
+   :caption: documenteer.toml
 
    [sphinx]
    python_api_dir = "dev/api/contents"
 
+.. _guide-sphinx-redirects:
+
+[sphinx.redirects]
+==================
+
+|optional|
+
+A table of paths to redirect to other paths. Use this setting to redirect old page locations to the new locations when a documentation site is reorganized.
+
+.. code-block:: toml
+   :caption: documenteer.toml
+
+   [sphinx.redirects]
+   "old/path" = "new/path"
+   "old/path2" = "new/path2"
+
 [sphinx.theme]
 ==============
 

documenteer-1.3.0/docs/guides/video-embeds.rst

@@ -0,0 +1,60 @@
+###############
+Embedded videos
+###############
+
+Videos and screencasts are a great way to show user interfaces in your documentation.
+Rubin Observatory has a Vimeo account where we store our documentation and user support videos.
+Rubin user guides have built-in directives, ``youtube`` and ``vimeo``, to embed video players into the documentation page.
+
+Embedding a Vimeo video
+=======================
+
+To embed a Vimeo video, use the ``vimeo`` directive with the video ID as the argument:
+
+.. tab-set::
+
+   .. tab-item:: reStructuredText
+      :sync: rst
+
+      .. code-block:: rst
+
+         .. vimeo:: 800911530
+
+   .. tab-item:: markdown
+      :sync: md
+
+      .. code-block:: markdown
+
+         :::vimeo 800911530
+
+The video ID is the number at the end of the video URL.
+For example, the video URL for the video with ID ``800911530`` is ``https://vimeo.com/800911530``.
+
+Embedding a YouTube video
+=========================
+
+To embed a YouTube video, use the ``youtube`` directive with the video ID as the argument:
+
+.. tab-set::
+
+   .. tab-item:: reStructuredText
+      :sync: rst
+
+      .. code-block:: rst
+
+         .. youtube:: yKqEDFvmYwY
+
+   .. tab-item:: markdown
+      :sync: md
+
+      .. code-block:: markdown
+
+         :::vimeo yKqEDFvmYwY
+
+The video ID is the string at the end of the video URL.
+For example, the video URL for the video with ID ``yKqEDFvmYwY`` is ``https://www.youtube.com/watch?v=yKqEDFvmYwY``.
+
+More information
+================
+
+- `sphinxcontrib-youtube <https://sphinxcontrib-youtube.readthedocs.io/en/latest/index.html>`__ is the Sphinx extension used to embed YouTube and Vimeo videos. See this documentation for additional options for using this extension.

{documenteer-1.2.2 → documenteer-1.3.0}/pyproject.toml

@@ -47,6 +47,7 @@ dev = [
     # Test depedendencies for analyzing HTML output
     "lxml",
     "cssselect",
+    "defusedxml",  # used by Sphinx but not declared as a dependency
     # Extensions for documenteer's own docs
     "sphinx-click",
     "sphinxcontrib-autoprogram",
@@ -56,6 +57,7 @@ dev = [
     "types-PyYAML",
     "types-docutils",
     "types-mock",
+    # Testing dependencies
 ]
 guide = [
     # Theme and extensions for Rubin user guide projects
@@ -74,6 +76,7 @@ guide = [
     "sphinxcontrib-redoc",
     "sphinxcontrib-jquery",
     "sphinxext-rediraffe",
+    "sphinxcontrib-youtube"
 ]
 pipelines = [
     # Theme and extensions for pipelines.lsst.io
@@ -100,12 +103,13 @@ pipelines = [
 ]
 technote = [
     # Theme and extensions for technotes
-    "technote>=0.7.0,<0.8.0",
+    "technote>=0.8.0,<0.9.0",
     "sphinx-prompt",
     "sphinxcontrib-mermaid",
     "sphinx-diagrams",
     "sphinx_design",
-    "myst-nb"
+    "myst-nb",
+    "sphinxcontrib-youtube"
 ]
 
 [project.urls]

{documenteer-1.2.2 → documenteer-1.3.0}/src/assets/rubin-technote/styles/components/_article-header.scss

@@ -5,7 +5,7 @@
   max-width: 12rem;
 }
 
-@media (max-width: 76rem) {
+@media (max-width: 76em) {
   // When the primary sidebar is hidden, remove extra top margin from the
   // container so the logo is closer to the top.
   .sb-container {
@@ -13,7 +13,7 @@
   }
 }
 
-@media (min-width: 76rem) {
+@media (min-width: 76em) {
   // Hide the mobile logo when the primary sidebar is visible.
   .mobile-rubin-technote-logo {
     display: none;

{documenteer-1.2.2 → documenteer-1.3.0}/src/assets/rubin-technote/styles/components/_authors.scss

@@ -3,6 +3,6 @@
  */
 
 .technote-inline-authors {
-  font-size: 1.1rem;
+  font-size: 1.1em;
   font-weight: 425;
 }

{documenteer-1.2.2 → documenteer-1.3.0}/src/documenteer/assets/rubin-technote.css

@@ -123,7 +123,7 @@
  * Custom styles for the author listing.
  */
 .technote-inline-authors {
-  font-size: 1.1rem;
+  font-size: 1.1em;
   font-weight: 425;
 }
 
@@ -190,12 +190,12 @@
   max-width: 12rem;
 }
 
-@media (max-width: 76rem) {
+@media (max-width: 76em) {
   .sb-container {
     margin-top: 0;
   }
 }
-@media (min-width: 76rem) {
+@media (min-width: 76em) {
   .mobile-rubin-technote-logo {
     display: none;
     margin: 0;

{documenteer-1.2.2 → documenteer-1.3.0}/src/documenteer/assets/rubin-technote.css.map

@@ -1 +1 @@
-{"version":3,"file":"rubin-technote.css","mappings":";;;AAAA;;;EAAA;AAKA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;ACAF;;ACrEA;;EAAA;AAIA;EACE;EACA;EACA;EACA;EACA;ADuEF;ACpEA;EACE;EACA;EACA;EACA;EACA;ADsEF;ACnEA;EACE;;0CAAA;EAGA;EACA;EACA;EACA;ADqEF;;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDqEF;AACF;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDoEF;AACF;AErHA;;EAAA;AAIA;EACE;EACA;AFsHF;;AG5HA;EACE;EACA;EACA;EACA;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AInJA;;;EAAA;AAKA;EACE;EACA;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;IACE;EJqJF;AACF;AK9KA;EACE;IACE;IACA;IACA;ELgLF;AACF;AMrLA;EACE;EACA;EACA;EACA;ANuLF;;AMpLA;EAGE;IACE;ENqLF;AACF;AMlLA;EAEE;IACE;IACA;ENmLF;AACF;AOvMA;;;;EAAA;AAMA;EAEE;;;;;;IAME;EPuMF;AACF;AOpMA;;EAAA;AAGA;EACE;EAEA;APqMF;;AOnMA;EACE;APsMF;;AAjOA;;;;EAAA,C","sources":["webpack:///./node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css","webpack:///./src/assets/rubin-technote/styles/rubin-technote.scss","webpack:///./src/assets/rubin-technote/styles/_properties.scss","webpack:///./src/assets/rubin-technote/styles/components/_authors.scss","webpack:///./src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss","webpack:///./src/assets/rubin-technote/styles/components/_version-info.scss","webpack:///./src/assets/rubin-technote/styles/components/_sidebar-section.scss","webpack:///./src/assets/rubin-technote/styles/components/_article-header.scss","webpack:///./src/assets/rubin-technote/styles/_hacks.scss"],"sourcesContent":["/**\n * Do not edit directly\n * Generated on Thu, 01 Dec 2022 19:33:46 GMT\n */\n\n:root {\n  --rsd-asset-image-favicon-svg: \"assets/favicon/rubin-favicon.svg\";\n  --rsd-asset-image-favicon-png-32-px: \"assets/favicon/rubin-favicon-transparent-32px.png\";\n  --rsd-asset-image-favicon-png-49-px: \"assets/favicon/rubin-favicon-transparent-49px.png\";\n  --rsd-asset-image-construction-agencies-png: \"assets/partner-logos/construction-agencies.png\"; /* Construction funding agency logo lineup (black on transparent). */\n  --rsd-asset-image-operations-agencies-png: \"assets/partner-logos/operations-lineup-black.png\"; /* Operations funding agency logo lineup (black on transparent). */\n  --rsd-asset-image-rubin-imagotype-color-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.svg\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.svg\";\n  --rsd-asset-image-rubin-imagotype-color-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-email-png: \"assets/rubin-imagotype/rubin-imagotype-email.png\";\n  --rsd-asset-image-rubin-watermark-watermark-png: \"assets/rubin-watermarks/rubin-watermark.png\";\n  --rsd-asset-image-rubin-watermark-letterhead-watermark-png: \"assets/rubin-watermarks/rubin-letterhead-watermark.png\";\n  --rsd-asset-image-rubin-watermark-letterhead-watermark-2-png: \"assets/rubin-watermarks/rubin-letterhead-watermark-2.png\";\n  --rsd-color-blue-500: #1c81a4;\n  --rsd-color-gray-100: #dce0e3;\n  --rsd-color-gray-500: #6a6e6e;\n  --rsd-color-gray-800: #1f2121;\n  --rsd-color-gray-900: #000000; /* Pure black. */\n  --rsd-color-gray-000: #ffffff; /* Pure white. */\n  --rsd-color-green-500: #3cae3f;\n  --rsd-color-imagotype-light: #00babc; /* Light teal in imagotype (graphic element). */\n  --rsd-color-imagotype-dark: #058b8c; /* Dark teal in imagotype (for Observatory wordmark). */\n  --rsd-color-imagotype-black: #313333; /* Dark gray in imagotype. */\n  --rsd-color-imagotype-white: #f5f5f5; /* Imagotype white for dark backgrounds. */\n  --rsd-color-orange-500: #ed4c4c;\n  --rsd-color-primary-100: #f5f5f5;\n  --rsd-color-primary-200: #d9f7f6;\n  --rsd-color-primary-300: #b1f2ef;\n  --rsd-color-primary-400: #00babc;\n  --rsd-color-primary-500: #009fa1;\n  --rsd-color-primary-600: #058b8c;\n  --rsd-color-primary-700: #0c4a47;\n  --rsd-color-primary-800: #313333;\n  --rsd-color-purple-500: #583671;\n  --rsd-color-red-500: #ed4c4c;\n  --rsd-color-yellow-500: #ffe266;\n  --rsd-component-footer-background-color: #f5f5f5;\n  --rsd-component-header-background-color: #1f2121; /* Header background color. */\n  --rsd-component-header-nav-text-color: #ffffff;\n  --rsd-component-header-nav-text-hover-color: #00babc;\n  --rsd-component-header-nav-menulist-text-color: #1f2121;\n  --rsd-component-header-nav-menulist-background-color: #ffffff;\n  --rsd-component-header-nav-menulist-selected-background-color: #058b8c;\n  --rsd-component-page-background-color: #ffffff; /* Page background color */\n  --rsd-component-service-card-background-color: #ffffff;\n  --rsd-component-service-card-text-color: #1f2121;\n  --rsd-component-text-color: #1f2121; /* Body text color */\n  --rsd-component-text-reverse-color: #dce0e3; /* Body text color in reversed (light on dark) contexts. */\n  --rsd-component-text-link-color: #146685;\n  --rsd-component-text-link-hover-color: #1c81a4;\n  --rsd-component-text-link-reverse-color: #1c81a4; /* Link color in reversed (light on dark) contexts. */\n  --rsd-component-text-headline-color: #058b8c;\n}\n","/*\n * Styles for Rubin technotes (documenteer.conf.technotebeta config).\n * These are intended to cascade *after* the base skeleton.css and\n * technote.css from https://technote.lsst.io.\n */\n\n@use '../../../../node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css';\n\n@use 'properties';\n@use 'components';\n@use 'hacks';\n","/*\n * Override technote CSS properties with Rubin Style Dictionary.\n */\n\n@font-face {\n  font-family: 'Source Sans 3 VF';\n  font-weight: 200 900;\n  font-style: normal;\n  font-stretch: normal;\n  src: url('./SourceSans3VF-Upright.ttf.woff2') format('woff2');\n}\n\n@font-face {\n  font-family: 'Source Sans 3 VF';\n  font-weight: 200 900;\n  font-style: italic;\n  font-stretch: normal;\n  src: url('./SourceSans3VF-Italic.ttf.woff2') format('woff2');\n}\n\n:root {\n  --tn-component-text-font-family: 'Source Sans 3 VF', -apple-system,\n    BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,\n    Droid Sans, Helvetica Neue, sans-serif;\n  --tn-component-text-color: var(--rsd-component-text-color);\n  --tn-component-toc-header-color: var(--rsd-color-primary-600);\n  --tn-component-sidebar-header-color: var(--rsd-color-primary-600);\n  --tn-component-toc-level-border-color: var(--rsd-color-primary-600);\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n  :root {\n    --tn-component-h1-weight: 600;\n    --tn-component-h2-weight: 500;\n    --tn-component-h3-weight: 600;\n    --tn-component-h4-weight: 700;\n    --tn-component-h5-weight: 800;\n    --tn-component-h6-weight: 800;\n  }\n}\n\n@media (max-width: 76rem) {\n  :root {\n    --tn-component-h1-size: 2.4rem;\n    --tn-component-h2-size: 1.8rem;\n    --tn-component-h3-size: 1.2rem;\n    --tn-component-h4-size: 1rem;\n    --tn-component-h5-size: 1rem;\n    --tn-component-h6-size: 1rem;\n  }\n}\n","/*\n * Custom styles for the author listing.\n */\n\n.technote-inline-authors {\n  font-size: 1.1rem;\n  font-weight: 425;\n}\n",".rubin-technote-global-breadcrumbs {\n  list-style: none;\n  margin-left: 0;\n  padding-left: 0;\n  margin: 0;\n}\n\n.rubin-technote-global-breadcrumbs li {\n  display: inline;\n}\n\n.rubin-technote-global-breadcrumbs li::after {\n  content: ' / ';\n}\n\n.rubin-technote-global-breadcrumbs li:last-child::after {\n  content: '';\n}\n\n.technote-article-header-id {\n  margin: var(--tn-space-xs) 0 var(--tn-space-xs);\n}\n","/*\n * The version info in the header-article section (located below the\n * technote ID)\n */\n\n.rubin-technote-version-info {\n  display: flex;\n  flex-direction: row;\n}\n\n.rubin-technote-version-info > p {\n  margin: 0 0 var(--tn-space-sm);\n}\n\n.rubin-technote-version-info > p {\n  margin-right: var(--tn-space-xl);\n}\n\n.rubin-technote-version-info > p:last-child {\n  margin-right: 0;\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n  .rubin-technote-version-info a {\n    font-weight: 500;\n  }\n}\n","@supports (font-variation-settings: 'wdth' 222) {\n  .technote-sidebar-section__heading {\n    font-weight: 600;\n    text-transform: uppercase;\n    letter-spacing: 0.01em; // goes well with upper case\n  }\n}\n",".mobile-rubin-technote-logo {\n  display: block;\n  margin: 0 auto 2rem auto;\n  width: 100%;\n  max-width: 12rem;\n}\n\n@media (max-width: 76rem) {\n  // When the primary sidebar is hidden, remove extra top margin from the\n  // container so the logo is closer to the top.\n  .sb-container {\n    margin-top: 0;\n  }\n}\n\n@media (min-width: 76rem) {\n  // Hide the mobile logo when the primary sidebar is visible.\n  .mobile-rubin-technote-logo {\n    display: none;\n    margin: 0;\n  }\n}\n","/*\n * Styles that are applied at the end of the selector stack to override\n * other selectors. These selectors should eventually be refactored into\n * their proper module either in documenteer or in the parent technote theme.\n */\n\n@media (max-width: 76rem) {\n  // Reduce the margin-bottom on headings in mobile views\n  h1,\n  h2,\n  h3,\n  h4,\n  h5,\n  h6 {\n    margin-bottom: 0.5em;\n  }\n}\n\n/*\n * Border specififcally for prompts, which act differently than code blocks.\n */\n.highlight-default .highlight {\n  border: var(--tn-sphinx-code-block-border-thickness) solid\n    var(--tn-sphinx-code-block-border-color);\n  border-radius: var(--tn-sphinx-code-block-border-radius);\n}\n.highlight-default .highlight pre {\n  margin: 1em;\n}\n"],"names":[],"sourceRoot":""}
+{"version":3,"file":"rubin-technote.css","mappings":";;;AAAA;;;EAAA;AAKA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;ACAF;;ACrEA;;EAAA;AAIA;EACE;EACA;EACA;EACA;EACA;ADuEF;ACpEA;EACE;EACA;EACA;EACA;EACA;ADsEF;ACnEA;EACE;;0CAAA;EAGA;EACA;EACA;EACA;ADqEF;;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDqEF;AACF;AClEA;EACE;IACE;IACA;IACA;IACA;IACA;IACA;EDoEF;AACF;AErHA;;EAAA;AAIA;EACE;EACA;AFsHF;;AG5HA;EACE;EACA;EACA;EACA;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AG5HA;EACE;AH+HF;;AInJA;;;EAAA;AAKA;EACE;EACA;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;AJqJF;;AIlJA;EACE;IACE;EJqJF;AACF;AK9KA;EACE;IACE;IACA;IACA;ELgLF;AACF;AMrLA;EACE;EACA;EACA;EACA;ANuLF;;AMpLA;EAGE;IACE;ENqLF;AACF;AMlLA;EAEE;IACE;IACA;ENmLF;AACF;AOvMA;;;;EAAA;AAMA;EAEE;;;;;;IAME;EPuMF;AACF;AOpMA;;EAAA;AAGA;EACE;EAEA;APqMF;;AOnMA;EACE;APsMF;;AAjOA;;;;EAAA,C","sources":["webpack:///./node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css","webpack:///./src/assets/rubin-technote/styles/rubin-technote.scss","webpack:///./src/assets/rubin-technote/styles/_properties.scss","webpack:///./src/assets/rubin-technote/styles/components/_authors.scss","webpack:///./src/assets/rubin-technote/styles/components/_global-breadcrumbs.scss","webpack:///./src/assets/rubin-technote/styles/components/_version-info.scss","webpack:///./src/assets/rubin-technote/styles/components/_sidebar-section.scss","webpack:///./src/assets/rubin-technote/styles/components/_article-header.scss","webpack:///./src/assets/rubin-technote/styles/_hacks.scss"],"sourcesContent":["/**\n * Do not edit directly\n * Generated on Thu, 01 Dec 2022 19:33:46 GMT\n */\n\n:root {\n  --rsd-asset-image-favicon-svg: \"assets/favicon/rubin-favicon.svg\";\n  --rsd-asset-image-favicon-png-32-px: \"assets/favicon/rubin-favicon-transparent-32px.png\";\n  --rsd-asset-image-favicon-png-49-px: \"assets/favicon/rubin-favicon-transparent-49px.png\";\n  --rsd-asset-image-construction-agencies-png: \"assets/partner-logos/construction-agencies.png\"; /* Construction funding agency logo lineup (black on transparent). */\n  --rsd-asset-image-operations-agencies-png: \"assets/partner-logos/operations-lineup-black.png\"; /* Operations funding agency logo lineup (black on transparent). */\n  --rsd-asset-image-rubin-imagotype-color-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black.svg\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white.svg\";\n  --rsd-asset-image-rubin-imagotype-color-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-black-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.png\";\n  --rsd-asset-image-rubin-imagotype-color-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-color-on-white-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-black-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-black-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-crop-png: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.png\";\n  --rsd-asset-image-rubin-imagotype-gray-on-white-crop-svg: \"assets/rubin-imagotype/rubin-imagotype-gray-on-white-crop.svg\";\n  --rsd-asset-image-rubin-imagotype-email-png: \"assets/rubin-imagotype/rubin-imagotype-email.png\";\n  --rsd-asset-image-rubin-watermark-watermark-png: \"assets/rubin-watermarks/rubin-watermark.png\";\n  --rsd-asset-image-rubin-watermark-letterhead-watermark-png: \"assets/rubin-watermarks/rubin-letterhead-watermark.png\";\n  --rsd-asset-image-rubin-watermark-letterhead-watermark-2-png: \"assets/rubin-watermarks/rubin-letterhead-watermark-2.png\";\n  --rsd-color-blue-500: #1c81a4;\n  --rsd-color-gray-100: #dce0e3;\n  --rsd-color-gray-500: #6a6e6e;\n  --rsd-color-gray-800: #1f2121;\n  --rsd-color-gray-900: #000000; /* Pure black. */\n  --rsd-color-gray-000: #ffffff; /* Pure white. */\n  --rsd-color-green-500: #3cae3f;\n  --rsd-color-imagotype-light: #00babc; /* Light teal in imagotype (graphic element). */\n  --rsd-color-imagotype-dark: #058b8c; /* Dark teal in imagotype (for Observatory wordmark). */\n  --rsd-color-imagotype-black: #313333; /* Dark gray in imagotype. */\n  --rsd-color-imagotype-white: #f5f5f5; /* Imagotype white for dark backgrounds. */\n  --rsd-color-orange-500: #ed4c4c;\n  --rsd-color-primary-100: #f5f5f5;\n  --rsd-color-primary-200: #d9f7f6;\n  --rsd-color-primary-300: #b1f2ef;\n  --rsd-color-primary-400: #00babc;\n  --rsd-color-primary-500: #009fa1;\n  --rsd-color-primary-600: #058b8c;\n  --rsd-color-primary-700: #0c4a47;\n  --rsd-color-primary-800: #313333;\n  --rsd-color-purple-500: #583671;\n  --rsd-color-red-500: #ed4c4c;\n  --rsd-color-yellow-500: #ffe266;\n  --rsd-component-footer-background-color: #f5f5f5;\n  --rsd-component-header-background-color: #1f2121; /* Header background color. */\n  --rsd-component-header-nav-text-color: #ffffff;\n  --rsd-component-header-nav-text-hover-color: #00babc;\n  --rsd-component-header-nav-menulist-text-color: #1f2121;\n  --rsd-component-header-nav-menulist-background-color: #ffffff;\n  --rsd-component-header-nav-menulist-selected-background-color: #058b8c;\n  --rsd-component-page-background-color: #ffffff; /* Page background color */\n  --rsd-component-service-card-background-color: #ffffff;\n  --rsd-component-service-card-text-color: #1f2121;\n  --rsd-component-text-color: #1f2121; /* Body text color */\n  --rsd-component-text-reverse-color: #dce0e3; /* Body text color in reversed (light on dark) contexts. */\n  --rsd-component-text-link-color: #146685;\n  --rsd-component-text-link-hover-color: #1c81a4;\n  --rsd-component-text-link-reverse-color: #1c81a4; /* Link color in reversed (light on dark) contexts. */\n  --rsd-component-text-headline-color: #058b8c;\n}\n","/*\n * Styles for Rubin technotes (documenteer.conf.technotebeta config).\n * These are intended to cascade *after* the base skeleton.css and\n * technote.css from https://technote.lsst.io.\n */\n\n@use '../../../../node_modules/@lsst-sqre/rubin-style-dictionary/dist/tokens.css';\n\n@use 'properties';\n@use 'components';\n@use 'hacks';\n","/*\n * Override technote CSS properties with Rubin Style Dictionary.\n */\n\n@font-face {\n  font-family: 'Source Sans 3 VF';\n  font-weight: 200 900;\n  font-style: normal;\n  font-stretch: normal;\n  src: url('./SourceSans3VF-Upright.ttf.woff2') format('woff2');\n}\n\n@font-face {\n  font-family: 'Source Sans 3 VF';\n  font-weight: 200 900;\n  font-style: italic;\n  font-stretch: normal;\n  src: url('./SourceSans3VF-Italic.ttf.woff2') format('woff2');\n}\n\n:root {\n  --tn-component-text-font-family: 'Source Sans 3 VF', -apple-system,\n    BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans,\n    Droid Sans, Helvetica Neue, sans-serif;\n  --tn-component-text-color: var(--rsd-component-text-color);\n  --tn-component-toc-header-color: var(--rsd-color-primary-600);\n  --tn-component-sidebar-header-color: var(--rsd-color-primary-600);\n  --tn-component-toc-level-border-color: var(--rsd-color-primary-600);\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n  :root {\n    --tn-component-h1-weight: 600;\n    --tn-component-h2-weight: 500;\n    --tn-component-h3-weight: 600;\n    --tn-component-h4-weight: 700;\n    --tn-component-h5-weight: 800;\n    --tn-component-h6-weight: 800;\n  }\n}\n\n@media (max-width: 76rem) {\n  :root {\n    --tn-component-h1-size: 2.4rem;\n    --tn-component-h2-size: 1.8rem;\n    --tn-component-h3-size: 1.2rem;\n    --tn-component-h4-size: 1rem;\n    --tn-component-h5-size: 1rem;\n    --tn-component-h6-size: 1rem;\n  }\n}\n","/*\n * Custom styles for the author listing.\n */\n\n.technote-inline-authors {\n  font-size: 1.1em;\n  font-weight: 425;\n}\n",".rubin-technote-global-breadcrumbs {\n  list-style: none;\n  margin-left: 0;\n  padding-left: 0;\n  margin: 0;\n}\n\n.rubin-technote-global-breadcrumbs li {\n  display: inline;\n}\n\n.rubin-technote-global-breadcrumbs li::after {\n  content: ' / ';\n}\n\n.rubin-technote-global-breadcrumbs li:last-child::after {\n  content: '';\n}\n\n.technote-article-header-id {\n  margin: var(--tn-space-xs) 0 var(--tn-space-xs);\n}\n","/*\n * The version info in the header-article section (located below the\n * technote ID)\n */\n\n.rubin-technote-version-info {\n  display: flex;\n  flex-direction: row;\n}\n\n.rubin-technote-version-info > p {\n  margin: 0 0 var(--tn-space-sm);\n}\n\n.rubin-technote-version-info > p {\n  margin-right: var(--tn-space-xl);\n}\n\n.rubin-technote-version-info > p:last-child {\n  margin-right: 0;\n}\n\n@supports (font-variation-settings: 'wdth' 222) {\n  .rubin-technote-version-info a {\n    font-weight: 500;\n  }\n}\n","@supports (font-variation-settings: 'wdth' 222) {\n  .technote-sidebar-section__heading {\n    font-weight: 600;\n    text-transform: uppercase;\n    letter-spacing: 0.01em; // goes well with upper case\n  }\n}\n",".mobile-rubin-technote-logo {\n  display: block;\n  margin: 0 auto 2rem auto;\n  width: 100%;\n  max-width: 12rem;\n}\n\n@media (max-width: 76em) {\n  // When the primary sidebar is hidden, remove extra top margin from the\n  // container so the logo is closer to the top.\n  .sb-container {\n    margin-top: 0;\n  }\n}\n\n@media (min-width: 76em) {\n  // Hide the mobile logo when the primary sidebar is visible.\n  .mobile-rubin-technote-logo {\n    display: none;\n    margin: 0;\n  }\n}\n","/*\n * Styles that are applied at the end of the selector stack to override\n * other selectors. These selectors should eventually be refactored into\n * their proper module either in documenteer or in the parent technote theme.\n */\n\n@media (max-width: 76rem) {\n  // Reduce the margin-bottom on headings in mobile views\n  h1,\n  h2,\n  h3,\n  h4,\n  h5,\n  h6 {\n    margin-bottom: 0.5em;\n  }\n}\n\n/*\n * Border specififcally for prompts, which act differently than code blocks.\n */\n.highlight-default .highlight {\n  border: var(--tn-sphinx-code-block-border-thickness) solid\n    var(--tn-sphinx-code-block-border-color);\n  border-radius: var(--tn-sphinx-code-block-border-radius);\n}\n.highlight-default .highlight pre {\n  margin: 1em;\n}\n"],"names":[],"sourceRoot":""}