Merge pull request #331 from joshmoore/pre3.1-cleanup

Cleanup the spec docs & builds for 3.1

Author: normanrz

docs/_static/js/mermaid.js

@@ -33,11 +33,6 @@
   'sphinx_reredirects',
 ]
 
-mermaid_version = ""
-html_js_files = [
-   'js/mermaid.js',  # v9.4.0
-]
-
 # Display todos by setting to True
 todo_include_todos = True
 
@@ -60,8 +55,12 @@
 
 html_theme_options = {
   "github_url": "https://github.com/zarr-developers/zarr-specs",
-  "twitter_url": "https://twitter.com/zarr_dev/",
   "icon_links": [
+    {
+      "name": "Bluesky",
+      "url": "https://bsky.app/profile/zarr.dev",
+      "icon": "fa-brands fa-bluesky",
+    },
     {
       "name": "Zulip",
       "url": "https://ossci.zulipchat.com/",
@@ -70,7 +69,6 @@
   ],
   "show_prev_next": False,
   "secondary_sidebar_items": ["page-toc"],
-  "footer_items": [],  # hidden in custom css
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/conf.py

@@ -1,4 +1,4 @@
-sphinx<6.0.0
-pydata-sphinx-theme==0.12.0
+sphinx
+pydata-sphinx-theme
 sphinxcontrib-mermaid
 sphinx-reredirects

docs/requirements.txt

@@ -2,6 +2,8 @@
 Specifications
 ==============
 
+.. _zarr-specs:
+
 .. toctree::
    :maxdepth: 1
    :caption: v3

docs/specs.rst

@@ -13,7 +13,7 @@ interpreted as described in `RFC 2119
 Status
 ------
 
-This specification is deprecated. See :ref:`spec` for the latest version.
+This specification is deprecated. See :ref:`zarr-specs` for the latest version.
 
 Storage
 -------

docs/v1/v1.0.rst

@@ -12,7 +12,7 @@ used for storing Zarr arrays. The key words "MUST", "MUST NOT", "REQUIRED",
 Status
 ------
 
-This specification is the latest version. See :ref:`spec` for previous
+This specification is the latest version. See :ref:`zarr-specs` for previous
 versions.
 
 .. _spec_v2_storage:

docs/v2/v2.0.rst

@@ -1,8 +1,8 @@
 .. _crc32c-codec-v1:
 
-============================
+====================================
  CRC32C checksum codec (version 1.0)
-============================
+====================================
 
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/crc32c/v1.0.html

docs/v3/codecs/crc32c/v1.0.rst

@@ -70,8 +70,8 @@ the Gzip codec configured with a compression level of 1::
     {
         "codecs": [{
             "name": "gzip",
-            "configuration": {                                                                                
-                "level": 1                                                                                    
+            "configuration": {
+                "level": 1
             }
         }],
     }

docs/v3/codecs/gzip/v1.0.rst

@@ -35,7 +35,7 @@ that can be individually compressed and accessed. This allows to colocate
 multiple chunks within one storage object, bundling them in shards.
 
 Status of this document
-======================
+=======================
 
 ZEP0002 was accepted on November 1st, 2023 via https://github.com/zarr-developers/zarr-specs/issues/254.