https://github.com/ashawley/scaladoc-test

Scaladoc test project
https://github.com/ashawley/scaladoc-test

Last synced: 5 days ago
JSON representation

Scaladoc test project

• Host: GitHub
• URL: https://github.com/ashawley/scaladoc-test
• Owner: ashawley
• Created: 2017-12-27T05:01:38.000Z (almost 7 years ago)
• Default Branch: apiMappings
• Last Pushed: 2018-01-31T23:09:29.000Z (almost 7 years ago)
• Last Synced: 2024-10-31T12:46:47.973Z (about 2 months ago)
• Language: Scala
• Homepage: https://ashawley.github.io/scaladoc-test/
• Size: 822 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Scaladoc test project

=====================

[![Build Status](https://travis-ci.org/ashawley/scaladoc-test.svg?branch=apiMappings)](https://travis-ci.org/ashawley/scaladoc-test)

    $ sbt

    > ++2.12.4

    [info] Setting version to 2.12.4

    [info] Reapplying settings...

    [info] Set current project to scaladoc-test (in build file:scaladoc-test/)

    > update

    [info] Updating {file:scaladoc-test/}scaladoc-test...

    [info] Done updating.

    > doc

    [info] Compiling 3 Scala sources to scaladoc-test/target/scala-2.12/classes...

    [info] Main Scala API documentation to scaladoc-test/target/scala-2.12/api...

    model contains 4 documentable templates

    [warn] scaladoc-test/src/library/scala/Oh.scala:6: Could not find any member to link for "scala.Null".

    [warn]   /** Nil of [[scala.Null]]. */

    [warn]   ^

    [warn] scaladoc-test/src/library/scala/Oh.scala:18: Could not find any member to link for "scala.Nothing".

    [warn]   /**

    [warn]   ^

    [warn] scaladoc-test/src/library/scala/Oh.scala:26: Could not find any member to link for "scala.String".

    [warn]   /** String of [[scala.String]] (aka [[java.lang.String]]). */

    [warn]   ^

    [warn] scaladoc-test/src/library/scala/Oh.scala:29: Could not find any member to link for "scala.Integer".

    [warn]   /** Zero of [[scala.Integer]]. */

    [warn]   ^

    [warn] four warnings found

    [info] Main Scala API documentation successful.

Publish on GitHub pages:

    $ cd target

    $ git init

    Initialized empty Git repository in ./scaladoc-test/target/.git/

    $ git remote add origin [email protected]:ashawley/scaladoc-test.git

    $ git fetch origin gh-pages

    From github.com:ashawley/scaladoc-test

     * branch            gh-pages   -> FETCH_HEAD

     * [new branch]      gh-pages   -> origin/gh-pages

    $ git checkout gh-pages

    Branch gh-pages set up to track remote branch gh-pages from origin.

    Switched to a new branch 'gh-pages'

    $ git add index.html

    $ git add -A scala-2.{11,12}/api/

    $ git commit