Skip to content

Commit e41e252

Browse files
borsboomborsboom
committed
Merge branch 'stable'
2 parents 28539a5 + 1448a41 commit e41e252

39 files changed

+478
-414
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ tags
1919
/*.iml
2020
/src/highlight.js
2121
/src/style.css
22-
/doc/_build
22+
/_site/

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Bug Reports
44

5-
Before reporting a bug, please ensure that you are using the latest release (currently stack-1.0.2). See the [upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade.html#upgrade) to upgrade.
5+
Before reporting a bug, please ensure that you are using the latest release (currently stack-1.0.2). See the [upgrade instructions](http://docs.haskellstack.org/en/stable/install_and_upgrade/#upgrade) to upgrade.
66

77
When reporting a bug, please write in the following format:
88

‎ChangeLog.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Release notes:
4545
- Arch Linux: Stack has been adopted into the
4646
[official community repository](https://www.archlinux.org/packages/community/x86_64/stack/),
4747
so we will no longer be updating the AUR with new versions. See the
48-
[install/upgrade guide](http://docs.haskellstack.org/en/stable/install_and_upgrade.html#arch-linux)
48+
[install/upgrade guide](http://docs.haskellstack.org/en/stable/install_and_upgrade/#arch-linux)
4949
for current download instructions.
5050

5151
Major changes:
@@ -180,16 +180,16 @@ Release notes:
180180
source code, so please check the links on the website before submitting a PR
181181
to fix them.
182182
* The locations of the
183-
[Ubuntu](http://docs.haskellstack.org/en/stable/install_and_upgrade.html#ubuntu)
183+
[Ubuntu](http://docs.haskellstack.org/en/stable/install_and_upgrade/#ubuntu)
184184
and
185-
[Debian](http://docs.haskellstack.org/en/stable/install_and_upgrade.html#debian)
185+
[Debian](http://docs.haskellstack.org/en/stable/install_and_upgrade/#debian)
186186
package repositories have changed to have correct URL semantics according to
187187
Debian's guidelines
188188
[#1378](https://github.com/commercialhaskell/stack/issues/1378). The old
189189
locations will continue to work for some months, but we suggest that you
190190
adjust your `/etc/apt/sources.list.d/fpco.list` to the new location to avoid
191191
future disruption.
192-
* [openSUSE and SUSE Linux Enterprise](http://docs.haskellstack.org/en/stable/install_and_upgrade.html#opensuse-suse-linux-enterprise)
192+
* [openSUSE and SUSE Linux Enterprise](http://docs.haskellstack.org/en/stable/install_and_upgrade/#opensuse-suse-linux-enterprise)
193193
packages are now available, thanks to [@mimi1vx](https://github.com/mimi1vx).
194194
Note: there will be some lag before these pick up new versions, as they are
195195
based on Stackage LTS.
@@ -244,7 +244,7 @@ Major changes:
244244

245245
* GHCJS can now be used with stackage snapshots via the new `compiler` field.
246246
* Windows installers are now available:
247-
[download them here](http://docs.haskellstack.org/en/stable/install_and_upgrade.html#windows)
247+
[download them here](http://docs.haskellstack.org/en/stable/install_and_upgrade/#windows)
248248
[#613](https://github.com/commercialhaskell/stack/issues/613)
249249
* Docker integration works with non-FPComplete generated images
250250
[#531](https://github.com/commercialhaskell/stack/issues/531)
@@ -458,7 +458,7 @@ Major changes:
458458
* Respect TemplateHaskell addDependentFile dependency changes ([#105](https://github.com/commercialhaskell/stack/issues/105))
459459
* TH dependent files are taken into account when determining whether a package needs to be built.
460460
* Overhauled target parsing, added `--test` and `--bench` options [#651](https://github.com/commercialhaskell/stack/issues/651)
461-
* For details, see [Build commands documentation](http://docs.haskellstack.org/en/stable/build_command.html)
461+
* For details, see [Build commands documentation](http://docs.haskellstack.org/en/stable/build_command/)
462462

463463
Other enhancements:
464464

‎GUIDE.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎doc/CONTRIBUTING.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML>
2+
<!-- This file exists only to redirect from old Sphinx URLs to new MkDocs URLs.
3+
This is more properly done using an HTTP redirect, but unfortunately
4+
readthedocs.org's page redirection is broken (see
5+
https://github.com/rtfd/readthedocs.org/issues/1826). Once that bug is fixed,
6+
this file, and its reference in mkdocs.yml, can be removed. -->
7+
<html lang="en-US">
8+
<head>
9+
<meta charset="UTF-8">
10+
<meta http-equiv="refresh" content="1;url=CONTRIBUTING/">
11+
<script type="text/javascript">
12+
window.location.href = "CONTRIBUTING/" + window.location.hash
13+
</script>
14+
<title>Page Redirection</title>
15+
</head>
16+
<body>
17+
If you are not redirected automatically, follow the <a href="CONTRIBUTING/'>link to CONTRIBUTING/</a>.
18+
</body>
19+
</html>

‎doc/ChangeLog.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML>
2+
<!-- This file exists only to redirect from old Sphinx URLs to new MkDocs URLs.
3+
This is more properly done using an HTTP redirect, but unfortunately
4+
readthedocs.org's page redirection is broken (see
5+
https://github.com/rtfd/readthedocs.org/issues/1826). Once that bug is fixed,
6+
this file, and its reference in mkdocs.yml, can be removed. -->
7+
<html lang="en-US">
8+
<head>
9+
<meta charset="UTF-8">
10+
<meta http-equiv="refresh" content="1;url=ChangeLog/">
11+
<script type="text/javascript">
12+
window.location.href = "ChangeLog/" + window.location.hash
13+
</script>
14+
<title>Page Redirection</title>
15+
</head>
16+
<body>
17+
If you are not redirected automatically, follow the <a href="ChangeLog/'>link to ChangeLog/</a>.
18+
</body>
19+
</html>

‎doc/GUIDE.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML>
2+
<!-- This file exists only to redirect from old Sphinx URLs to new MkDocs URLs.
3+
This is more properly done using an HTTP redirect, but unfortunately
4+
readthedocs.org's page redirection is broken (see
5+
https://github.com/rtfd/readthedocs.org/issues/1826). Once that bug is fixed,
6+
this file, and its reference in mkdocs.yml, can be removed. -->
7+
<html lang="en-US">
8+
<head>
9+
<meta charset="UTF-8">
10+
<meta http-equiv="refresh" content="1;url=GUIDE/">
11+
<script type="text/javascript">
12+
window.location.href = "GUIDE/" + window.location.hash
13+
</script>
14+
<title>Page Redirection</title>
15+
</head>
16+
<body>
17+
If you are not redirected automatically, follow the <a href="GUIDE/'>link to GUIDE/</a>.
18+
</body>
19+
</html>

‎doc/GUIDE.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ all commands work cross-platform, unless explicitly stated otherwise.
4848
## Downloading and Installation
4949

5050
The [documentation dedicated to downloading
51-
stack](install_and_upgrade.html) has the most
51+
stack](install_and_upgrade.md) has the most
5252
up-to-date information for a variety of operating systems, including multiple
5353
GNU/Linux flavors. Instead of repeating that content here, please go check out
5454
that page and come back here when you can successfully run `stack --version`.
@@ -619,7 +619,7 @@ At the time of writing:
619619
* Experimental custom snapshot support
620620

621621
The most up-to-date information can always be found in the
622-
[stack.yaml documentation](yaml_configuration.html#resolver).
622+
[stack.yaml documentation](yaml_configuration.md#resolver).
623623

624624
## Existing projects
625625

@@ -1227,7 +1227,7 @@ to build.
12271227

12281228
We're not going to cover the full generality of these arguments here; instead,
12291229
there's [documentation covering the full build command
1230-
syntax](build_command.html).
1230+
syntax](build_command.md).
12311231
Here, we'll just point out a few different types of arguments:
12321232

12331233
* You can specify a *package name*, e.g. `stack build vector`.
@@ -1364,7 +1364,7 @@ In addition to local directories, you can also refer to packages available in a
13641364
Git repository or in a tarball over HTTP/HTTPS. This can be useful for using a
13651365
modified version of a dependency that hasn't yet been released upstream. This is
13661366
a slightly more advanced usage that we won't go into detail with here, but it's
1367-
covered in the [stack.yaml documentation](yaml_configuration.html#packages).
1367+
covered in the [stack.yaml documentation](yaml_configuration.md#packages).
13681368

13691369
## Flags and GHC options
13701370

@@ -1452,7 +1452,7 @@ confusion.
14521452
Final point: if you have GHC options that you'll be regularly passing to your
14531453
packages, you can add them to your stack.yaml file (starting with
14541454
stack-0.1.4.0). See [the documentation section on
1455-
ghc-options](yaml_configuration.html#ghc-options)
1455+
ghc-options](yaml_configuration.md#ghc-options)
14561456
for more information.
14571457

14581458
## path
@@ -1745,7 +1745,7 @@ There are lots of resources available for learning more about stack:
17451745
* `--verbose` (or `-v`) — much more info about internal operations (useful for bug reports)
17461746
* The [home page](http://haskellstack.org)
17471747
* The [stack mailing list](https://groups.google.com/d/forum/haskell-stack)
1748-
* The [the FAQ](faq.html)
1748+
* The [the FAQ](faq.md)
17491749
* The [stack wiki](https://github.com/commercialhaskell/stack/wiki)
17501750
* The [haskell-stack tag on Stack Overflow](http://stackoverflow.com/questions/tagged/haskell-stack)
17511751
* [Another getting started with stack tutorial](http://seanhess.github.io/2015/08/04/practical-haskell-getting-started.html)
@@ -1802,13 +1802,13 @@ getting type information in Emacs. For more information, see
18021802
18031803
If you'd like to get some insight into the dependency tree of your packages, you
18041804
can use the `stack dot` command and Graphviz. More information is
1805-
[available in the Dependency visualization documentation](dependency_visualization.html).
1805+
[available in the Dependency visualization documentation](dependency_visualization.md).
18061806
18071807
### Travis with caching
18081808
18091809
Many people use Travis CI to test out a project for every Git push. We have [a
18101810
document devoted to
1811-
Travis](travis_ci.html). However, for
1811+
Travis](travis_ci.md). However, for
18121812
most people, the following example will be sufficient to get started:
18131813
18141814
```yaml
@@ -1998,7 +1998,7 @@ code inside a Docker image, which means:
19981998
a large initial download, but much faster builds
19991999

20002000
For more information, see
2001-
[the Docker-integration documentation](docker_integration.html).
2001+
[the Docker-integration documentation](docker_integration.md).
20022002

20032003
stack can also generate Docker images for you containing your built executables.
20042004
This feature is great for automating deployments from CI. This feature is not
@@ -2062,7 +2062,7 @@ in the common case or even to learn how to use the Nix tools (they're
20622062
called under the hood).
20632063

20642064
For more information, see
2065-
[the Nix-integration documentation](nix_integration.html).
2065+
[the Nix-integration documentation](nix_integration.md).
20662066

20672067
## Power user commands
20682068

‎doc/MAINTAINER_GUIDE.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML>
2+
<!-- This file exists only to redirect from old Sphinx URLs to new MkDocs URLs.
3+
This is more properly done using an HTTP redirect, but unfortunately
4+
readthedocs.org's page redirection is broken (see
5+
https://github.com/rtfd/readthedocs.org/issues/1826). Once that bug is fixed,
6+
this file, and its reference in mkdocs.yml, can be removed. -->
7+
<html lang="en-US">
8+
<head>
9+
<meta charset="UTF-8">
10+
<meta http-equiv="refresh" content="1;url=MAINTAINER_GUIDE/">
11+
<script type="text/javascript">
12+
window.location.href = "MAINTAINER_GUIDE/" + window.location.hash
13+
</script>
14+
<title>Page Redirection</title>
15+
</head>
16+
<body>
17+
If you are not redirected automatically, follow the <a href="MAINTAINER_GUIDE/'>link to MAINTAINER_GUIDE/</a>.
18+
</body>
19+
</html>

‎doc/MAINTAINER_GUIDE.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ to go:
3838
"obvious" version in sequence (if doing a non-obvious jump) and replace
3939
with new version
4040
* Look for any links to "latest" documentation, replace with version tag
41-
* Ensure all inter-doc links use `.html` extension (not `.md`)
42-
* Ensure all documentation pages listed in `doc/index.rst`
41+
* Ensure all documentation pages listed in `mkdocs.yaml`
4342
* Check that any new Linux distribution versions added to
4443
`etc/scripts/release.hs` and `etc/scripts/vagrant-releases.sh`
4544
* Check that no new entries need to be added to

0 commit comments

Comments
 (0)