From 00f3ea7fc0c27b0077b5427a5aac927f56f8282f Mon Sep 17 00:00:00 2001 From: Alejandro Wainzinger Date: Sat, 21 Nov 2015 17:45:37 +0900 Subject: [PATCH] Add documentation for building Sphinx documentation. --- slick/src/sphinx/index.rst | 1 + slick/src/sphinx/links.txt | 1 + slick/src/sphinx/sphinx-documentation.rst | 14 ++++++++++++++ 3 files changed, 16 insertions(+) create mode 100644 slick/src/sphinx/sphinx-documentation.rst diff --git a/slick/src/sphinx/index.rst b/slick/src/sphinx/index.rst index 1119aac28b..5dcf243bc6 100644 --- a/slick/src/sphinx/index.rst +++ b/slick/src/sphinx/index.rst @@ -40,3 +40,4 @@ ________ :maxdepth: 3 testkit + sphinx-documentation diff --git a/slick/src/sphinx/links.txt b/slick/src/sphinx/links.txt index 248a8e235d..0c5f47fb09 100644 --- a/slick/src/sphinx/links.txt +++ b/slick/src/sphinx/links.txt @@ -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 diff --git a/slick/src/sphinx/sphinx-documentation.rst b/slick/src/sphinx/sphinx-documentation.rst new file mode 100644 index 0000000000..9c0ea3c12f --- /dev/null +++ b/slick/src/sphinx/sphinx-documentation.rst @@ -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. \ No newline at end of file