Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs #7637

Merged
merged 3 commits into from
Sep 11, 2021
Merged

Fix docs #7637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9c4682
doc: Activate sphinx-jsonschema extension for build-info docs
DanielG Sep 11, 2021
0c327f0
doc: Fix shpinx warnings
DanielG Sep 11, 2021
08fd3ee
doc: Fix example json code block in build-info docs
DanielG Sep 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
4 changes: 2 additions & 2 deletions doc/developing-packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <http://semver.org>`__; however, for packages intended to be
distributed via Hackage Haskell's `Package Versioning Policy`_ applies
distributed via Hackage Haskell's `Package Versioning Policy <https://pvp.haskell.org/>`_ applies
(see also the `PVP/SemVer FAQ section <https://pvp.haskell.org/faq/#semver>`__).

The combination of package name and version is called the *package ID*
Expand Down
3 changes: 2 additions & 1 deletion doc/setup-commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<cabal lib version>",
"compiler": {
Expand Down