Merge upstream into main

YosysHQ · Nov 28, 2024 · 0034bdb · 0034bdb
2 parents 94f5672 + fd3e7b9
commit 0034bdb
Show file tree

Hide file tree

Showing 21 changed files with 330 additions and 313 deletions.
diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml
@@ -26,6 +26,12 @@ body:
       description: A clear and concise description of what should've happened.
     validations:
       required: true
+  - type: checkboxes
+    attributes:
+      label: This was requested by a maintainer.
+      options:
+        - label: I was asked to open an issue in a [discussion](https://github.com/pradyunsg/furo/discussions) by a maintainer.
+          required: true
   - type: checkboxes
     attributes:
       label: Code of Conduct

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,7 +11,7 @@ repos:
       - id: black
 
   - repo: https://github.com/asottile/blacken-docs
-    rev: 1.16.0
+    rev: 1.18.0
     hooks:
       - id: blacken-docs
 
@@ -36,7 +36,7 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.4.2
+    rev: v0.5.5
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -11,6 +11,21 @@ https://en.wikipedia.org/wiki/Lists_of_colors
 
 -->
 
+## 2024.08.06 -- Energetic Eminence
+
+- ✨ Add support for Sphinx 8
+- ✨ Add smoother transitions between breakpoints
+- Increase specificity of table-wrapper selector
+- Avoid page breaks inside paragraphs
+
+## 2024.07.18 -- Dull Denim
+
+- Improve how icons are handled and aligned.
+- Improve scroll event handler.
+- Hide the copybutton by default.
+- Fix `source_view_link` configuration handling.
+- Fix close tag on pencil icon.
+
 ## 2024.05.06 -- Cheerful Cerulean
 
 - ✨ Add new custom icons for auto mode, reflecting the currently active theme.

diff --git a/docs/customisation/footer.md b/docs/customisation/footer.md
@@ -103,4 +103,5 @@ If you wish to use Font Awesome icons in the footer, it's a two step process.
 You can specify `only-light` or `only-dark` as the value for `class` in the dictionary. This mechanism exists primarily to help you use different `img` tags to present the same icon in a different colour.
 
 [^1]: Yes, I'm aware that it can be argued that embedding raw HTML in a `conf.py` file is... ugly. :)
+
 [^2]: You need to use your browser's developer tools to get the SVG directly from the page: inspect element + copy svg element (ctrl+c) + paste.
diff --git a/docs/kitchen-sink/generic.rst b/docs/kitchen-sink/generic.rst
@@ -114,7 +114,7 @@ Sidebar
 
     Lorem ipsum dolor sit amet consectetur adipisicing elit.
 
-    .. image:: https://source.unsplash.com/200x200/daily?cute+puppy
+    .. image:: https://picsum.photos/id/237/200/200
 
     Lorem ipsum dolor sit amet consectetur adipisicing elit.
 
@@ -272,4 +272,4 @@ voluptatem officia culpa optio atque. Quaerat sed quibusdam ratione nam.
 Download Links
 ==============
 
-:download:`This long long long long long long long long long long long long long long long download link should wrap white-spaces <https://source.unsplash.com/200x200/daily?cute+puppy>`
+:download:`This long long long long long long long long long long long long long long long download link should wrap white-spaces <https://picsum.photos/id/237/200/200>`
diff --git a/docs/kitchen-sink/images.rst b/docs/kitchen-sink/images.rst
@@ -12,18 +12,18 @@ Images
 
 An image:
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. image:: https://picsum.photos/id/237/200/200
    :height: 200
    :width: 200
 
 A clickable image:
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. image:: https://picsum.photos/id/237/200/200
    :target: https://unsplash.com/
    :height: 200
    :width: 200
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. image:: https://picsum.photos/id/237/200/200
    :align: right
    :height: 200
    :width: 200
@@ -43,7 +43,7 @@ sapiente veritatis doloribus accusantium molestiae modi recusandae
 excepturi facere, corrupti expedita sit nihil temporibus eius sequi
 animi, illo libero labore fuga.
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. image:: https://picsum.photos/id/237/200/200
    :align: left
    :height: 200
    :width: 200
@@ -66,7 +66,7 @@ animi, illo libero labore fuga.
 Figures
 -------
 
-.. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. figure:: https://picsum.photos/id/237/200/200
    :alt: reStructuredText, the markup syntax
 
    A figure is an image with a caption and/or a legend:
@@ -83,7 +83,7 @@ Figures
 
 A figure directive with center alignment
 
-.. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. figure:: https://picsum.photos/id/237/200/200
    :align: center
 
    This caption should be centered.
diff --git a/docs/kitchen-sink/lists.rst b/docs/kitchen-sink/lists.rst
@@ -254,11 +254,11 @@ Hlists
 .. hlist::
     :columns: 2
 
-    - .. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+    - .. figure:: https://picsum.photos/id/237/200/200
 
          This is a short caption for a figure.
 
-    - .. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+    - .. figure:: https://picsum.photos/id/237/200/200
 
          This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
          Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.

diff --git a/docs/kitchen-sink/structure.rst b/docs/kitchen-sink/structure.rst
@@ -84,7 +84,7 @@ luctus efficitur arcu. Cras ut dictum mi. Nulla congue interdum lorem, semper se
 Document Subsection
 -------------------
 
-.. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+.. figure:: https://picsum.photos/id/237/200/200
     :align: right
     :figwidth: 200px
 

diff --git a/docs/kitchen-sink/tables.rst b/docs/kitchen-sink/tables.rst
@@ -101,11 +101,11 @@ List Tables
 
 .. list-table:: This is a list table with images in it.
 
-    * - .. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+    * - .. figure:: https://picsum.photos/id/237/200/200
 
            This is a short caption for a figure.
 
-      - .. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
+      - .. figure:: https://picsum.photos/id/237/200/200
 
            This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
            Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.
diff --git a/docs/reference/images.md b/docs/reference/images.md
@@ -5,29 +5,29 @@ Images can be a great supplement to technical documentation text. Sphinx provide
 ## Basic Usage
 
 ```{furo-demo}
-![](https://source.unsplash.com/200x200/daily?cute+animals)
+![](https://picsum.photos/id/237/200/200)
 
 This is from Markdown.
 
 +++
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+animals
+.. image:: https://picsum.photos/id/237/200/200
 
 This is from reStructuredText.
 ```
 
 ## Alignment
 
 ````{furo-demo}
-```{image} https://source.unsplash.com/200x200/daily?cute+animals
+```{image} https://picsum.photos/id/237/200/200
 :align: center
 ```
 
 This is from Markdown.
 
 +++
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+animals
+.. image:: https://picsum.photos/id/237/200/200
    :align: center
 
 
@@ -38,15 +38,15 @@ This is from reStructuredText.
 
 ````{furo-demo}
 
-```{figure} https://source.unsplash.com/200x200/daily?cute+animals
+```{figure} https://picsum.photos/id/237/200/200
 This is a captioned image, which needs the "figure" directive.
 ```
 
 This is from Markdown.
 
 +++
 
-.. figure:: https://source.unsplash.com/200x200/daily?cute+animals
+.. figure:: https://picsum.photos/id/237/200/200
 
     This is a captioned image, which needs the "figure" directive.
 
@@ -66,22 +66,22 @@ based on the currently active colour scheme.
 
 ````{furo-demo}
 
-```{image} https://source.unsplash.com/200x200/daily?cute+dogs
+```{image} https://picsum.photos/id/237/200/200
 :align: center
 :class: only-light
 ```
 
-```{image} https://source.unsplash.com/200x200/daily?cute+cats
+```{image} https://picsum.photos/id/237/200/200
 :align: center
 :class: only-dark
 ```
 
-```{figure} https://source.unsplash.com/200x200/daily?cute+cats
+```{figure} https://picsum.photos/id/237/200/200
 :align: center
 :figclass: only-light
 ```
 
-```{figure} https://source.unsplash.com/200x200/daily?cute+dogs
+```{figure} https://picsum.photos/id/237/200/200
 :align: center
 :figclass: only-dark
 ```
@@ -90,22 +90,22 @@ This is from Markdown.
 
 +++
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+dogs
+.. image:: https://picsum.photos/id/237/200/200
    :align: center
    :class: only-light
 
 
-.. image:: https://source.unsplash.com/200x200/daily?cute+cats
+.. image:: https://picsum.photos/id/237/200/200
    :align: center
    :class: only-dark
 
 
-.. figure:: https://source.unsplash.com/200x200/daily?cute+cats
+.. figure:: https://picsum.photos/id/237/200/200
    :align: center
    :figclass: only-light
 
 
-.. figure:: https://source.unsplash.com/200x200/daily?cute+dogs
+.. figure:: https://picsum.photos/id/237/200/200
    :align: center
    :figclass: only-dark
Original file line number	Diff line number	Diff line change
Expand Up		@@ -103,4 +103,5 @@ If you wish to use Font Awesome icons in the footer, it's a two step process.
		You can specify `only-light` or `only-dark` as the value for `class` in the dictionary. This mechanism exists primarily to help you use different `img` tags to present the same icon in a different colour.

		[^1]: Yes, I'm aware that it can be argued that embedding raw HTML in a `conf.py` file is... ugly. :)

		[^2]: You need to use your browser's developer tools to get the SVG directly from the page: inspect element + copy svg element (ctrl+c) + paste.