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.

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

Docs: Revive useful links section. Update URLs. #861

Merged
merged 5 commits into from
Feb 4, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion core/src/main/scala/cats/FlatMap.scala
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import simulacrum.typeclass
* but we can't implement pure (because we wouldn't know what key to use
* when instantiating the new Map).
*
* @see See [[https://github.com/non/cats/issues/3]] for some discussion.
* @see See [[https://github.com/typelevel/cats/issues/3]] for some discussion.
*
* Must obey the laws defined in cats.laws.FlatMapLaws.
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/applicative.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Applicative"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Applicative.scala"
source: "core/src/main/scala/cats/Applicative.scala"
scaladoc: "#cats.Applicative"
---
# Applicative
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Apply"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Apply.scala"
source: "core/src/main/scala/cats/Apply.scala"
scaladoc: "#cats.Apply"
---
# Apply
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/const.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Const"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Const.scala"
source: "core/src/main/scala/cats/data/Const.scala"
scaladoc: "#cats.data.Const"
---
# Const
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/contravariant.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Contravariant"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/functor/Contravariant.scala"
source: "core/src/main/scala/cats/functor/Contravariant.scala"
scaladoc: "#cats.functor.Contravariant"
---
# Contravariant
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/foldable.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Foldable"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Foldable.scala"
source: "core/src/main/scala/cats/Foldable.scala"
scaladoc: "#cats.Foldable"
---
# Foldable
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/freeapplicative.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "FreeApplicatives"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/free/FreeApplicative.scala"
source: "core/src/main/scala/cats/free/FreeApplicative.scala"
scaladoc: "#cats.free.FreeApplicative"
---
# Free Applicative
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/freemonad.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "FreeMonads"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/free/Free.scala"
source: "core/src/main/scala/cats/free/Free.scala"
scaladoc: "#cats.free.Free"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/functor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Functor"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Functor.scala"
source: "core/src/main/scala/cats/Functor.scala"
scaladoc: "#cats.Functor"
---
# Functor
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/id.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Id"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala"
source: "core/src/main/scala/cats/package.scala"
scaladoc: "#cats.Id$"
---
# Id
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/invariant.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Invariant"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/functor/Invariant.scala"
source: "core/src/main/scala/cats/functor/Invariant.scala"
scaladoc: "#cats.functor.Invariant"
---
# Invariant
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/kleisli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Kleisli"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Kleisli.scala"
source: "core/src/main/scala/cats/data/Kleisli.scala"
scaladoc: "#cats.data.Kleisli"
---
# Kleisli
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/monad.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Monad"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Monad.scala"
source: "core/src/main/scala/cats/Monad.scala"
scaladoc: "#cats.Monad"
---
# Monad
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/monadcombine.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "MonadCombine"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/MonadCombine.scala"
source: "core/src/main/scala/cats/MonadCombine.scala"
scaladoc: "#cats.MonadCombine"
---
# MonadCombine
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/monadfilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "MonadFilter"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/MonadFilter.scala"
source: "core/src/main/scala/cats/MonadFilter.scala"
scaladoc: "#cats.MonadFilter"
---
# MonadFilter
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/monoid.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,6 @@ N.B.
Cats does not define a `Monoid` type class itself, it uses the [`Monoid`
trait](https://github.com/non/algebra/blob/master/core/src/main/scala/algebra/Monoid.scala)
which is defined in the [algebra project](https://github.com/non/algebra) on
which it depends. The [`cats` package object](https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala)
which it depends. The [`cats` package object](https://github.com/typelevel/cats/blob/master/core/src/main/scala/cats/package.scala)
defines type aliases to the `Monoid` from algebra, so that you can
`import cats.Monoid`.
2 changes: 1 addition & 1 deletion docs/src/main/tut/monoidk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "MonoidK"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/MonoidK.scala"
source: "core/src/main/scala/cats/MonoidK.scala"
scaladoc: "#cats.MonoidK"
---
# MonoidK
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/oneand.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "OneAnd"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/OneAnd.scala"
source: "core/src/main/scala/cats/data/OneAnd.scala"
scaladoc: "#cats.data.OneAnd"
---
# OneAnd
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/optiont.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "OptionT"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/OptionT.scala"
source: "core/src/main/scala/cats/data/OptionT.scala"
scaladoc: "#cats.data.OptionT"
---
# OptionT
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/tut/semigroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ N.B.
Cats does not define a `Semigroup` type class itself, it uses the [`Semigroup`
trait](https://github.com/non/algebra/blob/master/core/src/main/scala/algebra/Semigroup.scala)
which is defined in the [algebra project](https://github.com/non/algebra) on
which it depends. The [`cats` package object](https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala)
which it depends. The [`cats` package object](https://github.com/typelevel/cats/blob/master/core/src/main/scala/cats/package.scala)
defines type aliases to the `Semigroup` from algebra, so that you can
`import cats.Semigroup`.
`import cats.Semigroup`.
4 changes: 2 additions & 2 deletions docs/src/main/tut/semigroupk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "SemigroupK"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/SemigroupK.scala"
source: "core/src/main/scala/cats/SemigroupK.scala"
scaladoc: "#cats.SemigroupK"
---
# SemigroupK
Expand Down Expand Up @@ -30,7 +30,7 @@ Cats does not define a `Semigroup` type class itself. Instead, we use the
trait](https://github.com/non/algebra/blob/master/core/src/main/scala/algebra/Semigroup.scala)
which is defined in the [algebra
project](https://github.com/non/algebra). The [`cats` package
object](https://github.com/non/cats/blob/master/core/src/main/scala/cats/package.scala)
object](https://github.com/typelevel/cats/blob/master/core/src/main/scala/cats/package.scala)
defines type aliases to the `Semigroup` from algebra, so that you can
`import cats.semigroup`.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Show"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Show.scala"
source: "core/src/main/scala/cats/Show.scala"
scaladoc: "#cats.Show"
---
# Show
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/state.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "State"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/StateT.scala"
source: "core/src/main/scala/cats/data/StateT.scala"
scaladoc: "#cats.data.StateT"
---
# State
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/streaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Streaming"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Streaming.scala"
source: "core/src/main/scala/cats/data/Streaming.scala"
scaladoc: "#cats.data.Streaming"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/traverse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Traverse"
section: "typeclasses"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/Traverse.scala"
source: "core/src/main/scala/cats/Traverse.scala"
scaladoc: "#cats.Traverse"
---
# Traverse
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/validated.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Validated"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Validated.scala"
source: "core/src/main/scala/cats/data/Validated.scala"
scaladoc: "#cats.data.Validated"
---
# Validated
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/tut/xor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: "Xor"
section: "data"
source: "https://github.com/non/cats/blob/master/core/src/main/scala/cats/data/Xor.scala"
source: "core/src/main/scala/cats/data/Xor.scala"
scaladoc: "#cats.data.Xor"
---
# Xor
Expand Down
1 change: 1 addition & 0 deletions docs/src/site/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ markdown: redcarpet
highlighter: pygments
baseurl: /cats
apidocs: /cats/api/
sources: https://github.com/typelevel/cats/blob/master/

collections:
tut:
Expand Down
25 changes: 17 additions & 8 deletions docs/src/site/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
<div id="commute"><img src="http://plastic-idolatry.com/erik/cats2.png"/></div>
<div id="toolbox">
<table id="tooltable">
<tr><td class="label">Source:</td><td class="link"><a href="https://github.com/non/cats">Github</a></td></tr>
<tr><td class="label">Chat:</td><td class="link"><a href="https://gitter.im/non/cats">Gitter</a></td></tr>
<tr><td class="label">Build:</td><td class="link"><a href="https://travis-ci.org/non/cats">Travis</a></td></tr>
<tr><td class="label">Source:</td><td class="link"><a href="https://github.com/typelevel/cats">Github</a></td></tr>
<tr><td class="label">Chat:</td><td class="link"><a href="https://gitter.im/typelevel/cats">Gitter</a></td></tr>
<tr><td class="label">Build:</td><td class="link"><a href="https://travis-ci.org/typelevel/cats">Travis</a></td></tr>
<tr><td class="label">Api:</td><td class="link"><a href="{{site.apidocs}}">Scaladoc</a></td></tr>
</table>
</div>
Expand All @@ -46,7 +46,7 @@ <h1>Cats</h1>
<li {%if page.section =="typeclasses" %} class="active" {% else %} class="inactive" {% endif%}>
<a href="{{ site.baseurl }}/typeclasses.html">Typeclasses</a>
</li>
<li {%if page.section =="datatypes" %} class="active" {% else %} class="inactive" {% endif %}>
<li {%if page.section =="data" %} class="active" {% else %} class="inactive" {% endif %}>
<a href="{{ site.baseurl }}/datatypes.html">Data Types</a>
</li>
<li {%if page.section == "resources_for_learners" %} class="active" {% else %} class="inactive" {% endif %}>
Expand All @@ -61,12 +61,21 @@ <h1>Cats</h1>
{{ content }}
</div>
</div>
{% if (page.section == 'data') or (page.section == 'typeclasses') and ((page.source != null) or (page.scaladoc != null))%}
<div id="extra">
<h5>useful links</h5>
<!--workaround of poor boolean algebra implementation (see: http://stackoverflow.com/questions/23054564/how-to-use-multiple-arguments-in-an-if-statement-with-liquid?answertab=oldest#tab-top) -->
{% if (page.section == 'data') or (page.section == 'typeclasses') %}
{% assign linksSection = true %}
{% endif %}
{% if (page.source != null) or (page.scaladoc != null) %}
{% assign linksContent = true %}
{% endif %}
{% if linksSection and linksContent %}
<div id="extra">
<h5>Useful links:</h5>
<ul>
{% if page.source != null %}
{% if (page.source != null) and (page.source contains 'https:') %}
<li><a href="{{page.source}}">Source</a></li>
{% elsif page.source != null %}
<li><a href="{{site.sources}}{{page.source}}">Source</a></li>
{% endif %}
{% if page.scaladoc != null %}
<li><a href="{{site.apidocs}}{{ page.scaladoc }}">Scaladoc</a></li>
Expand Down
20 changes: 15 additions & 5 deletions docs/src/site/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -90,21 +90,31 @@ div#content {

div#extra {
background: #EEEEFF;
width: 150px;
margin-right: 50px;
margin-left: -100%;
margin-top: 50px;
# float: right;
padding: 10px;
}

div#extra h5 {
display: inline;
margin-bottom: 0;
}

div#extra ul {
display:inline;
list-style-type: none;
text-align: center;
margin: 0;
padding: 0;
}

div#extra ul li {
display: inline;
font-weight: bold;
font-size: 0.83em;
margin-left: 3px;
}

div#footer {
clear:left;
}
Expand Down Expand Up @@ -203,14 +213,14 @@ div#navbar li a {

li#active {
float: left;
diplay: inline-block;
display: inline-block;
color: black
color: white

}
li#active a {
float: left;
diplay: inline-block;
display: inline-block;
color: black;
background: white;

Expand Down
7 changes: 2 additions & 5 deletions docs/src/site/datatypes.html → docs/src/site/datatypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,10 @@
title: "Data Types"
section: "data"
---
# Data Types

<h1>Data Types</h1>

<ul>
{% for x in site.tut %}
{% if x.section == 'data' %}
<li><a href="{{ site.baseurl }}{{ x.url }}">{{ x.title }}</a></li>
- [{{x.title}}]({{site.baseurl}}{{x.url}})
{% endif %}
{% endfor %}
</ul>
4 changes: 2 additions & 2 deletions docs/src/site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ functionality, you can pick-and-choose from amongst these modules
* `cats-core`: Core type classes and functionality (*required*).
* `cats-laws`: Laws for testing type class instances.

Release notes for Cats are available in [CHANGES.md](https://github.com/non/cats/blob/master/CHANGES.md).
Release notes for Cats are available in [CHANGES.md](https://github.com/typelevel/cats/blob/master/CHANGES.md).

<a name "motivations"></a>
# Motivations
Expand Down Expand Up @@ -95,7 +95,7 @@ In an attempt to be more modular, Cats is broken up into a number of sub-project

All code is available to you under the MIT license, available at
http://opensource.org/licenses/mit-license.php and also in the
[COPYING](https://raw.githubusercontent.com/non/cats/master/COPYING) file. The design is informed by many other
[COPYING](https://raw.githubusercontent.com/typelevel/cats/master/COPYING) file. The design is informed by many other
projects, in particular Scalaz.

Copyright the maintainers, 2015.