Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
GHC
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
sheaf
GHC
Commits
2dfc268c
Commit
2dfc268c
authored
3 years ago
by
Eric Lindblad
Committed by
Marge Bot
3 years ago
Browse files
Options
Downloads
Patches
Plain Diff
update URLs
parent
564b89ae
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/users_guide/editing-guide.rst
+16
-16
16 additions, 16 deletions
docs/users_guide/editing-guide.rst
with
16 additions
and
16 deletions
docs/users_guide/editing-guide.rst
+
16
−
16
View file @
2dfc268c
...
...
@@ -6,15 +6,15 @@ for the Glasgow Haskell Compiler. Even more than this, it at times serves (for
better or for worse) as a de-facto language standard, being the sole
non-academic reference for many widely used language extensions.
Since GHC 8.0, the User's Guide is authored in `
R
eStructuredText
<https://en.wikipedia.org/wiki/ReStructuredText>`__ (or
R
eST or RST, for short)
Since GHC 8.0, the User's Guide is authored in `
r
eStructuredText
<https://en.wikipedia.org/wiki/ReStructuredText>`__ (or
r
eST or RST, for short)
a rich but light-weight mark-up language aimed at producing documentation. The
`Sphinx <http://sphinx-doc.org/>`__ tool is used to produce the final PDF and
`Sphinx <http
s
://
www.
sphinx-doc.org/>`__ tool is used to produce the final PDF and
HTML documentation.
This document (also written in
R
eST) serves as a brief introduction to
R
eST and to
This document (also written in
r
eST) serves as a brief introduction to
r
eST and to
document the conventions used in the User's Guide. This document is *not* intended
to be a thorough guide to
R
eST. For this see the resources referenced
to be a thorough guide to
r
eST. For this see the resources referenced
`below <#references>`__.
Basics
...
...
@@ -91,7 +91,7 @@ The above would be rendered as,
Headings
~~~~~~~~
While
R
eST can accommodate a wide range of heading styles, we have standardized
While
r
eST can accommodate a wide range of heading styles, we have standardized
on this convention in the User's Guide,
.. code-block:: rest
...
...
@@ -141,7 +141,7 @@ Other languages
Double-colon blocks are syntax-highlighted as Haskell by default. To avoid this
use a
``.. code-block`` `directive
<http://sphinx-doc.org/
markup/code
.html#directive-code-block>`__ with explicit
<http
s
://
www.
sphinx-doc.org/
en/master/usage/restructuredtext/directives
.html#directive-code-block>`__ with explicit
language designation,
.. code-block:: rest
...
...
@@ -314,7 +314,7 @@ There are a number of admonitions types,
* warning
.. _Admonitions: http://docutils.sourceforge.
net
/docs/ref/rst/directives.html#admonitions
.. _Admonitions: http
s
://docutils.sourceforge.
io
/docs/ref/rst/directives.html#admonitions
Documenting command-line options and GHCi commands
--------------------------------------------------
...
...
@@ -421,15 +421,15 @@ user-substitutable tokens. In this document we use the convention, ``⟨subst⟩
less-than/greater-than signs).
R
eST reference materials
r
eST reference materials
------------------------
* `Sphinx
R
eST Primer`_: A great place to start.
* `Sphinx extensions`_: How Sphinx extends
R
eST
* `
R
eST reference`_: When you really need the details.
* `Sphinx
r
eST Primer`_: A great place to start.
* `Sphinx extensions`_: How Sphinx extends
r
eST
* `
r
eST reference`_: When you really need the details.
* `Directives reference`_
.. _Sphinx
R
eST Primer: http://sphinx-doc.org/
rest
.html
.. _
R
eST reference: http://docutils.sourceforge.
net
/docs/ref/rst/restructuredtext.html
.. _Sphinx extensions: http://sphinx-doc.org/
markup
/index.html
.. _Directives reference: http://docutils.sourceforge.
net
/docs/ref/rst/directives.html#code
.. _Sphinx
r
eST Primer: http
s
://
www.
sphinx-doc.org/
en/master/usage/restructuredtext/basics
.html
.. _
r
eST reference: http
s
://docutils.sourceforge.
io
/docs/ref/rst/restructuredtext.html
.. _Sphinx extensions: http
s
://
www.
sphinx-doc.org/
en/master/usage/extensions
/index.html
.. _Directives reference: http
s
://docutils.sourceforge.
io
/docs/ref/rst/directives.html#code
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment