Permalink
Browse files

Add documentation for building Sphinx documentation.

  • Loading branch information...
1 parent 0290716 commit 00f3ea7fc0c27b0077b5427a5aac927f56f8282f @xevix xevix committed Nov 21, 2015
Showing with 16 additions and 0 deletions.
  1. +1 −0 slick/src/sphinx/index.rst
  2. +1 −0 slick/src/sphinx/links.txt
  3. +14 −0 slick/src/sphinx/sphinx-documentation.rst
@@ -40,3 +40,4 @@ ________
:maxdepth: 3
testkit
+ sphinx-documentation
@@ -12,6 +12,7 @@
.. _Play: https://playframework.com/
.. _Akka: http://akka.io/
.. _Akka Streams: http://akka.io/docs/
+.. _Akka Sphinx: http://doc.akka.io/docs/akka/2.4.0/dev/documentation.html
.. _About Pool Sizing: https://github.com/brettwooldridge/HikariCP/wiki/About-Pool-Sizing
.. _Reactive Streams: http://www.reactive-streams.org/
.. _JPA: http://en.wikipedia.org/wiki/Java_Persistence_API
@@ -0,0 +1,14 @@
+Sphinx Documentation
+====================
+
+Building
+--------
+
+Slick documentation is written in reStructuredText and is compiled by Sphinx via the sbt-site plugin.
+
+.. code-block:: bash
+
+ # Generate HTML documentation in slick/target/sphinx/html/
+ sbt sphinx:generateHtml
+
+For more details on Sphinx installation and usage in Scala projects, see the `Akka Sphinx`_ documentation.

0 comments on commit 00f3ea7

Please sign in to comment.