Use '//' to denote comments in JSON code block

Previously, there was a docs build warning: WARNING: Could not lex literal_block as "json". Highlighting skipped. This fixes the warning. Pin pygments to a minimum of 2.12.0 since that is the earliest version to support this type of comment¹. ¹ https://pygments.org/docs/changelog/#version-2-12-0
nextstrain · Mar 10, 2023 · 78b9439 · 78b9439
1 parent 65a82ca
commit 78b9439
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -11,3 +11,4 @@ dependencies:
     - sphinx-autobuild
     - sphinx-markdown-tables
     - sphinx-argparse
+    - pygments>=2.12.0  # For JSON with comments
diff --git a/docs/server/api.rst b/docs/server/api.rst
@@ -33,11 +33,11 @@ The Auspice server handles requests to 3 API endpoints made by the Auspice clien
          "secondTreeOptions": "[optional] A list of requests which should \
              appear as potential second-trees in the sidebar dropdown"
        },
-       ...
+       // ...
      ],
      "narratives": [
        {"request": "URL of a narrative. Will become the prefix in a getNarrative request"},
-       ...
+       // ...
      ]
    }