diff --git a/src/sphinx/Detailed-Topics/Advanced-Index.rst b/src/sphinx/Detailed-Topics/Advanced-Index.rst new file mode 100644 index 000000000..28928ed7e --- /dev/null +++ b/src/sphinx/Detailed-Topics/Advanced-Index.rst @@ -0,0 +1,19 @@ +========== + Advanced +========== + +This part of the documentation has pages documenting particular sbt topics in detail. +Before reading anything in here, you will need the information in the +:doc:`Getting Started Guide ` as a foundation. + +.. toctree:: + :maxdepth: 2 + + Launcher + Scripts + TaskInputs + Understanding-incremental-recompilation + /Extending/Build-Loaders + /Extending/Command-Line-Applications + /Extending/Settings-Core + Migrating-from-sbt-0.7.x-to-0.10.x diff --git a/src/sphinx/Detailed-Topics/Best-Practices.rst b/src/sphinx/Detailed-Topics/Best-Practices.rst index dfd846ebd..89849fa20 100644 --- a/src/sphinx/Detailed-Topics/Best-Practices.rst +++ b/src/sphinx/Detailed-Topics/Best-Practices.rst @@ -1,6 +1,6 @@ -============== -Best Practices -============== +====================== +General Best Practices +====================== This page describes best practices for working with sbt. @@ -102,7 +102,7 @@ For example: // The result of makeFile is the constructed File, // so useFile can map makeFile and simultaneously // get the File and declare the dependency on makeFile - useFile := + useFile := doSomething( makeFile.value ) This arrangement is not always possible, but it should be the rule and @@ -153,16 +153,14 @@ Parser combinators .. code-block:: scala - lazy val parser: Parser[Int] = + lazy val parser: Parser[Int] = token(IntBasic) flatMap { i => if(i <= 0) success(i) else - token(Space ~> parser) + token(Space ~> parser) } This example defines a parser a whitespace-delimited list of integers, ending with a negative number, and returning that final, negative number. - - diff --git a/src/sphinx/Detailed-Topics/Command-Details-Index.rst b/src/sphinx/Detailed-Topics/Command-Details-Index.rst new file mode 100644 index 000000000..39c069471 --- /dev/null +++ b/src/sphinx/Detailed-Topics/Command-Details-Index.rst @@ -0,0 +1,16 @@ +========= +Using sbt +========= + +This part of the documentation has pages documenting particular sbt topics in detail. +Before reading anything in here, you will need the information in the +:doc:`Getting Started Guide ` as a foundation. + +.. toctree:: + :maxdepth: 2 + + Command-Line-Reference + Console-Project + Cross-Build + Inspecting-Settings + Triggered-Execution diff --git a/src/sphinx/Detailed-Topics/Configuration-Index.rst b/src/sphinx/Detailed-Topics/Configuration-Index.rst new file mode 100644 index 000000000..b3a26a1b9 --- /dev/null +++ b/src/sphinx/Detailed-Topics/Configuration-Index.rst @@ -0,0 +1,29 @@ +============= +Configuration +============= + +This part of the documentation has pages documenting particular sbt topics in detail. +Before reading anything in here, you will need the information in the +:doc:`Getting Started Guide ` as a foundation. + +.. toctree:: + :maxdepth: 2 + + Classpaths + Compiler-Plugins + Configuring-Scala + Forking + Global-Settings + Java-Sources + Mapping-Files + Local-Scala + Macro-Projects + Paths + Parallel-Execution + Process + Running-Project-Code + Testing + Tasks + /Extending/Input-Tasks + Parsing-Input + Setup-Notes diff --git a/src/sphinx/Detailed-Topics/Dependency-Management-Index.rst b/src/sphinx/Detailed-Topics/Dependency-Management-Index.rst new file mode 100644 index 000000000..fd771b880 --- /dev/null +++ b/src/sphinx/Detailed-Topics/Dependency-Management-Index.rst @@ -0,0 +1,18 @@ +======================= + Dependency Management +======================= + +This part of the documentation has pages documenting particular sbt topics in detail. +Before reading anything in here, you will need the information in the +:doc:`Getting Started Guide ` as a foundation. + +.. toctree:: + :maxdepth: 2 + + Artifacts + Dependency-Management-Flow + Library-Management + Proxy-Repositories + Publishing + Resolvers + Update-Report diff --git a/src/sphinx/Detailed-Topics/Plugins-and-Best-Practices.rst b/src/sphinx/Detailed-Topics/Plugins-and-Best-Practices.rst new file mode 100644 index 000000000..4a4d0acae --- /dev/null +++ b/src/sphinx/Detailed-Topics/Plugins-and-Best-Practices.rst @@ -0,0 +1,14 @@ +========================== +Plugins and Best Practices +========================== + +This part of the documentation has pages documenting particular sbt topics in detail. +Before reading anything in here, you will need the information in the +:doc:`Getting Started Guide ` as a foundation. + +.. toctree:: + :maxdepth: 2 + + Best-Practices + /Extending/Plugins-Best-Practices + /Extending/Plugins diff --git a/src/sphinx/Detailed-Topics/Tasks-and-Commands.rst b/src/sphinx/Detailed-Topics/Tasks-and-Commands.rst new file mode 100644 index 000000000..1a58e3ee9 --- /dev/null +++ b/src/sphinx/Detailed-Topics/Tasks-and-Commands.rst @@ -0,0 +1,16 @@ +============================ +Tasks, Commands, and Plugins +============================ + +This part of the documentation has pages documenting particular sbt topics in detail. +Before reading anything in here, you will need the information in the +:doc:`Getting Started Guide ` as a foundation. + +.. toctree:: + :maxdepth: 2 + + Tasks + /Extending/Input-Tasks + /Extending/Commands + Parsing-Input + /Extending/Build-State diff --git a/src/sphinx/Detailed-Topics/index.rst b/src/sphinx/Detailed-Topics/index.rst index ed242601f..f7bebe4fc 100644 --- a/src/sphinx/Detailed-Topics/index.rst +++ b/src/sphinx/Detailed-Topics/index.rst @@ -7,11 +7,15 @@ Before reading anything in here, you will need the information in the :doc:`Getting Started Guide ` as a foundation. Other resources include the :doc:`Examples ` and -:doc:`extending sbt ` areas on the wiki, and the +:doc:`extending sbt ` areas on the wiki, and the `API Documentation <../../api/index.html>`_ .. toctree:: :maxdepth: 2 - :glob: - * + Command-Details-Index + Configuration-Index + Dependency-Management-Index + Tasks-and-Commands + Plugins-and-Best-Practices + Advanced-Index diff --git a/src/sphinx/Examples/index.rst b/src/sphinx/Examples/index.rst index 1310aaed8..ed3325003 100644 --- a/src/sphinx/Examples/index.rst +++ b/src/sphinx/Examples/index.rst @@ -11,8 +11,7 @@ as a foundation for understanding the examples. .. toctree:: :maxdepth: 1 - Advanced-Command-Example - Advanced-Configurations-Example - Full-Configuration-Example Quick-Configuration-Examples - + Full-Configuration-Example + Advanced-Configurations-Example + Advanced-Command-Example diff --git a/src/sphinx/Extending/index.rst b/src/sphinx/Extending/index.rst index a3c520f7f..998c66530 100644 --- a/src/sphinx/Extending/index.rst +++ b/src/sphinx/Extending/index.rst @@ -2,13 +2,4 @@ Extending sbt ============= -This part of the documentation has pages on how to extend sbt with plugins and commands. - -To understand the pages in here, you'll need the -:doc:`Getting Started Guide ` as a foundation. - -.. toctree:: - :maxdepth: 2 - :glob: - - * +Pages previously listed here are now included under :doc:`Detailed Topics `. diff --git a/src/sphinx/conf.py b/src/sphinx/conf.py index 6ea043d06..a98fc6165 100644 --- a/src/sphinx/conf.py +++ b/src/sphinx/conf.py @@ -89,7 +89,7 @@ rst_epilog = """ .. _ZIP: %(sbt_native_package_base)s%(release)s/sbt.zip .. _DEB: %(sbt_native_package_base)s%(release)s/sbt.deb .. _RPM: %(sbt_native_package_base)s%(release)s/sbt.rpm -.. |nightly-launcher| replace:: <%(launcher_snapshots_base)s +.. |nightly-launcher| replace:: %(launcher_snapshots_base)s .. _sbt-dev mailing list: https://groups.google.com/forum/#!forum/sbt-dev .. _adept: https://groups.google.com/group/adept-dev/topics .. _sbt-launcher-package: https://github.com/sbt/sbt-launcher-package diff --git a/src/sphinx/index.rst b/src/sphinx/index.rst index da1ce99e2..3169538b7 100644 --- a/src/sphinx/index.rst +++ b/src/sphinx/index.rst @@ -15,12 +15,11 @@ the :doc:`index of names and types `. :maxdepth: 2 Getting-Started/index - Detailed-Topics/index - Examples/index Howto/index faq Community/index - Extending/index + Detailed-Topics/index + Examples/index Name-Index @@ -35,4 +34,5 @@ the :doc:`index of names and types `. Community/ChangeSummary_0.12.0 Community/ChangeSummary_0.13.0 Community/Repository-Rules + Community/Bintray-For-Plugins pdf_index