From a9c4682a96417502b42d7fedaa9a98d19ed91494 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Gr=C3=B6ber?= Date: Sat, 11 Sep 2021 15:36:44 +0200 Subject: [PATCH 1/3] doc: Activate sphinx-jsonschema extension for build-info docs --- doc/conf.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index cac2ec7c45b..3350df95a4e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -15,7 +15,11 @@ version = "3.6.0.0" -extensions = ['sphinx.ext.extlinks', 'sphinx.ext.todo'] +extensions = [ + 'sphinx.ext.extlinks', + 'sphinx.ext.todo', + 'sphinx-jsonschema' +] templates_path = ['_templates'] source_suffix = '.rst' From 0c327f02c16cd6909c4ed31f577e96e57d4247dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Gr=C3=B6ber?= Date: Sat, 11 Sep 2021 15:45:03 +0200 Subject: [PATCH 2/3] doc: Fix shpinx warnings --- doc/developing-packages.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/developing-packages.rst b/doc/developing-packages.rst index 42412c12a36..1327b66d51d 100644 --- a/doc/developing-packages.rst +++ b/doc/developing-packages.rst @@ -257,7 +257,7 @@ your libraries and executable sections. For example: Proglet Note that the ``import`` **must** be the first thing in the stanza. For more -information see the `Common stanzas`_ section. +information see the :ref:`common-stanzas` section. Building the package @@ -356,7 +356,7 @@ of digits such as "1.0.1" or "2.0". There are a range of common conventions for "versioning" packages, that is giving some meaning to the version number in terms of changes in the package, such as e.g. `SemVer `__; however, for packages intended to be -distributed via Hackage Haskell's `Package Versioning Policy`_ applies +distributed via Hackage Haskell's `Package Versioning Policy `_ applies (see also the `PVP/SemVer FAQ section `__). The combination of package name and version is called the *package ID* From 08fd3eeba221b7beb859903b8c4079baab0dbb9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Gr=C3=B6ber?= Date: Sat, 11 Sep 2021 15:45:18 +0200 Subject: [PATCH 3/3] doc: Fix example json code block in build-info docs --- doc/setup-commands.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/setup-commands.rst b/doc/setup-commands.rst index 12c4f32f89b..fae32af01ae 100644 --- a/doc/setup-commands.rst +++ b/doc/setup-commands.rst @@ -1050,7 +1050,8 @@ Miscellaneous options experimental. In the future we might add or remove fields, depending on the needs of other tooling. - :: example + .. code-block:: json + { "cabal-lib-version": "", "compiler": {