Permalink
Browse files

Merge pull request #35 from funkyboy/master

New format for documentation
  • Loading branch information...
2 parents bca9c77 + c9a6c62 commit 60d7af6e6dc6a906654d6c526273dc8066616017 @funkyboy funkyboy committed Feb 17, 2014
Showing with 6,147 additions and 18,650 deletions.
  1. BIN .DS_Store
  2. +0 −1 .gitignore
  3. +0 −73 Advanced/hacking.rst
  4. +0 −7 Advanced/index.rst
  5. +29 −0 Gemfile
  6. +13 −0 LICENSE
  7. +0 −153 Makefile
  8. +5 −0 README.md
  9. +3 −0 Rakefile
  10. BIN RestAPI/.DS_Store
  11. BIN RestAPI/Admin/.DS_Store
  12. +0 −10 RestAPI/Admin/admin_application_settings.rst
  13. +0 −156 RestAPI/Admin/admin_assets.rst
  14. +0 −55 RestAPI/Admin/admin_collections.rst
  15. +0 −99 RestAPI/Admin/admin_database_management.rst
  16. +0 −21 RestAPI/Admin/admin_system_metrics.rst
  17. +0 −62 RestAPI/Admin/admin_users.rst
  18. +0 −12 RestAPI/Admin/index.rst
  19. BIN RestAPI/Users/.DS_Store
  20. +0 −9 RestAPI/Users/index.rst
  21. +0 −188 RestAPI/Users/social_login.rst
  22. +0 −446 RestAPI/Users/users.rst
  23. +0 −40 RestAPI/assets.rst
  24. +0 −433 RestAPI/documents.rst
  25. +0 −233 RestAPI/file.rst
  26. +0 −123 RestAPI/general_remarks.rst
  27. +0 −15 RestAPI/index.rst
  28. +0 −79 RestAPI/push_notifications.rst
  29. +0 −129 RestAPI/settings.rst
  30. BIN SDK/.DS_Store
  31. BIN SDK/Android/.DS_Store
  32. +0 −7 SDK/Android/index.rst
  33. +0 −195 SDK/Android/user_guide_android.rst
  34. BIN SDK/iOS/.DS_Store
  35. +0 −401 SDK/iOS/getting_started_ios.rst
  36. +0 −6 SDK/iOS/index.rst
  37. +0 −463 SDK/iOS/ios_sdk.rst
  38. +0 −215 SDK/iOS/user_guide_ios.rst
  39. +0 −10 SDK/index.rst
  40. BIN _static/.DS_Store
  41. BIN _static/Console_0.6.0/53083208c1f7f299a1b60a634a9d2a09.media.600x402.png
  42. BIN _static/Console_0.6.0/76043bc4472533574babeb222c1c55cc.media.1024x534.png
  43. BIN _static/Console_0.6.0/assets.png
  44. BIN _static/Console_0.6.0/baasbox_0-6-0-console.png
  45. BIN _static/Console_0.6.0/collections.png
  46. BIN _static/Console_0.6.0/documents.png
  47. BIN _static/Console_0.6.0/edit_settings.png
  48. BIN _static/Console_0.6.0/f3655beefd279784e9d888ddacec2737.media.600x319.png
  49. BIN _static/Console_0.6.0/home_console.png
  50. BIN _static/Console_0.6.0/login.png
  51. BIN _static/Console_0.6.0/news.png
  52. BIN _static/Console_0.6.0/users.png
  53. BIN _static/Console_0.7.2/.DS_Store
  54. BIN _static/Console_0.7.3/.DS_Store
  55. BIN _static/Console_0.7.3/baasbox-db-management.png
  56. BIN _static/Console_0.7.3/baasbox-documents-table.png
  57. BIN _static/Console_0.7.3/baasbox_console.png
  58. BIN _static/Console_0.7.3/create_new_collection.png
  59. BIN _static/Console_0.7.3/create_new_user.png
  60. BIN _static/Console_0.7.3/new_asset.png
  61. BIN _static/Social-Login/.DS_Store
  62. BIN _static/Social-Login/Tutorial/.DS_Store
  63. BIN _static/Social-Login/Tutorial/img1.png
  64. BIN _static/Social-Login/Tutorial/img10.png
  65. BIN _static/Social-Login/Tutorial/img11.png
  66. BIN _static/Social-Login/Tutorial/img12.png
  67. BIN _static/Social-Login/Tutorial/img13.png
  68. BIN _static/Social-Login/Tutorial/img14.png
  69. BIN _static/Social-Login/Tutorial/img1_bck.png
  70. BIN _static/Social-Login/Tutorial/img2.png
  71. BIN _static/Social-Login/Tutorial/img3.png
  72. BIN _static/Social-Login/Tutorial/img5.png
  73. BIN _static/Social-Login/Tutorial/img6.png
  74. BIN _static/Social-Login/Tutorial/img7.png
  75. BIN _static/Social-Login/Tutorial/img8.png
  76. BIN _static/Social-Login/Tutorial/img9.png
  77. BIN _static/Social-Login/img1.png
  78. BIN _static/Social-Login/img2.png
  79. BIN _static/Tutorial/.DS_Store
  80. BIN _static/Tutorial/Dear_diary/.DS_Store
  81. BIN _static/Tutorial/Dear_diary/001-DearDiary_add-new-memo.png
  82. BIN _static/Tutorial/Dear_diary/001-DearDiary_dashboard-baasbox.png
  83. BIN _static/Tutorial/Dear_diary/001-DearDiary_edit-title-body.png
  84. BIN _static/Tutorial/Dear_diary/001-DearDiary_import-sdk-ios-0-1-5.png
  85. BIN _static/Tutorial/Dear_diary/001-DearDiary_launch-baasbox.png
  86. BIN _static/Tutorial/Dear_diary/001-DearDiary_login-baasbox.png
  87. BIN _static/Tutorial/Dear_diary/001-DearDiary_new-collection-baasbox.png
  88. BIN _static/Tutorial/Dear_diary/001-DearDiary_see-post-collections-dashboard.png
  89. BIN _static/Tutorial/Dear_diary/001-DearDiary_signup-login.png
  90. +0 −3 _static/default.css
  91. +0 −13 _themes/.gitignore
  92. +0 −181 _themes/baasbox/layout.html
  93. +0 −5 _themes/baasbox/searchbox.html
  94. +0 −115 _themes/baasbox/static/css/background-image.css
  95. +0 −184 _themes/baasbox/static/css/background-image.less
  96. +0 −120 _themes/baasbox/static/css/background-pattern.css
  97. +0 −180 _themes/baasbox/static/css/background-pattern.less
  98. +0 −1,824 _themes/baasbox/static/css/basic.css
  99. +0 −1,838 _themes/baasbox/static/css/basic.less
  100. +0 −52 _themes/baasbox/static/css/ie.css
  101. +0 −127 _themes/baasbox/static/css/ie.less
  102. +0 −1 _themes/baasbox/static/css/theme.css
  103. +0 −1,203 _themes/baasbox/static/font-awesome/css/font-awesome-ie7.css
  104. +0 −384 _themes/baasbox/static/font-awesome/css/font-awesome-ie7.min.css
  105. +0 −1,487 _themes/baasbox/static/font-awesome/css/font-awesome.css
  106. +0 −403 _themes/baasbox/static/font-awesome/css/font-awesome.min.css
  107. BIN _themes/baasbox/static/font-awesome/font/FontAwesome.otf
  108. BIN _themes/baasbox/static/font-awesome/font/fontawesome-webfont.eot
  109. +0 −399 _themes/baasbox/static/font-awesome/font/fontawesome-webfont.svg
  110. BIN _themes/baasbox/static/font-awesome/font/fontawesome-webfont.ttf
  111. BIN _themes/baasbox/static/font-awesome/font/fontawesome-webfont.woff
  112. BIN _themes/baasbox/static/img/background/background-image.jpg
  113. BIN _themes/baasbox/static/img/background/wood_pattern.png
  114. BIN _themes/baasbox/static/img/home/home_phone.png
  115. BIN _themes/baasbox/static/img/home/home_tablet.png
  116. BIN _themes/baasbox/static/img/home/phone-display.png
  117. BIN _themes/baasbox/static/img/home/tablet-display.png
  118. BIN _themes/baasbox/static/img/partners/partner1.png
  119. BIN _themes/baasbox/static/img/partners/partner2.png
  120. BIN _themes/baasbox/static/img/partners/partner3.png
  121. BIN _themes/baasbox/static/img/partners/partner4.png
  122. BIN _themes/baasbox/static/img/partners/partner5.png
  123. BIN _themes/baasbox/static/img/slider/appstore.png
  124. BIN _themes/baasbox/static/img/slider/googleplay.png
  125. BIN _themes/baasbox/static/img/slider/slider_phone.png
  126. BIN _themes/baasbox/static/img/slider/slider_phone2.png
  127. BIN _themes/baasbox/static/img/slider/slider_phone3.png
  128. BIN _themes/baasbox/static/img/team/designer.png
  129. BIN _themes/baasbox/static/img/team/developer.png
  130. BIN _themes/baasbox/static/img/team/director.png
  131. BIN _themes/baasbox/static/img/team/seo.png
  132. +0 −12 _themes/baasbox/static/js/map.js
  133. +0 −165 _themes/baasbox/static/js/script.js
  134. +0 −7 _themes/baasbox/theme.conf
  135. +0 −37 _themes/baasbox/versions.html
  136. +0 −17 _themes/sphinx_rtd_theme/__init__.py
  137. +0 −6 _themes/sphinx_rtd_theme/breadcrumbs.html
  138. +0 −3 _themes/sphinx_rtd_theme/download.html
  139. +0 −30 _themes/sphinx_rtd_theme/footer.html
  140. +0 −138 _themes/sphinx_rtd_theme/layout.html
  141. +0 −205 _themes/sphinx_rtd_theme/layout_old.html
  142. +0 −50 _themes/sphinx_rtd_theme/search.html
  143. +0 −6 _themes/sphinx_rtd_theme/searchbox.html
  144. +0 −1 _themes/sphinx_rtd_theme/static/css/badge_only.css
  145. +0 −3,741 _themes/sphinx_rtd_theme/static/css/theme.css
  146. BIN _themes/sphinx_rtd_theme/static/font/fontawesome_webfont.eot
  147. +0 −399 _themes/sphinx_rtd_theme/static/font/fontawesome_webfont.svg
  148. BIN _themes/sphinx_rtd_theme/static/font/fontawesome_webfont.ttf
  149. BIN _themes/sphinx_rtd_theme/static/font/fontawesome_webfont.woff
  150. +0 −3 _themes/sphinx_rtd_theme/static/js/theme.js
  151. +0 −7 _themes/sphinx_rtd_theme/theme.conf
  152. +0 −26 _themes/sphinx_rtd_theme/versions.html
  153. +0 −194 access_log
  154. +0 −191 agent_log
  155. +0 −24 assets.rst
  156. +0 −245 conf.py
  157. +36 −0 config.rb
  158. +0 −181 console.rst
  159. +0 −16 custom_error_code.rst
  160. 0 error_log
  161. +0 −60 general_overview.rst
  162. +0 −77 hacking.rst
  163. +0 −59 index.rst
  164. +0 −29 installation.rst
  165. +0 −28 introduction.rst
  166. +0 −190 make.bat
  167. +0 −66 push_notifications.rst
  168. +0 −141 referer_log
  169. +0 −121 setting.rst
  170. BIN source/fonts/icomoon.eot
  171. +17 −0 source/fonts/icomoon.svg
  172. BIN source/fonts/icomoon.ttf
  173. BIN source/fonts/icomoon.woff
  174. BIN {_static → source/images}/Console_0.7.2/assets.png
  175. BIN {_static/Console_0.6.0 → source/images/Console_0.7.2}/baasbox-db-management.png
  176. BIN {_static/Console_0.6.0 → source/images/Console_0.7.2}/baasbox-documents-table.png
  177. BIN {_static → source/images}/Console_0.7.2/baasbox_0-7-2-console.png
  178. BIN {_static → source/images}/Console_0.7.2/collections.png
  179. BIN {_static/Console_0.6.0 → source/images/Console_0.7.2}/create_new_collection.png
  180. BIN {_static/Console_0.6.0 → source/images/Console_0.7.2}/create_new_user.png
  181. BIN {_static → source/images}/Console_0.7.2/documents.png
  182. BIN {_static → source/images}/Console_0.7.2/home_console.png
  183. BIN source/images/Console_0.7.2/image_resize.png
  184. BIN {_static → source/images}/Console_0.7.2/login.png
  185. BIN {_static/Console_0.6.0 → source/images/Console_0.7.2}/new_asset.png
  186. BIN {_static → source/images}/Console_0.7.2/news.png
  187. BIN {_static → source/images}/Console_0.7.2/settings.png
  188. BIN {_static → source/images}/Console_0.7.2/social_login1.png
  189. BIN {_static → source/images}/Console_0.7.2/social_login2.png
  190. BIN {_static → source/images}/Console_0.7.2/users.png
  191. BIN {_static → source/images}/Console_0.7.3/assets.png
  192. BIN {_static/Console_0.7.2 → source/images/Console_0.7.3}/baasbox-db-management.png
  193. BIN {_static/Console_0.7.2 → source/images/Console_0.7.3}/baasbox-documents-table.png
  194. BIN {_static → source/images}/Console_0.7.3/baasbox_0-7-3-console.png
  195. BIN {_static → source/images}/Console_0.7.3/collections.png
  196. BIN {_static/Console_0.7.2 → source/images/Console_0.7.3}/create_new_collection.png
  197. BIN {_static/Console_0.7.2 → source/images/Console_0.7.3}/create_new_user.png
  198. BIN {_static → source/images}/Console_0.7.3/documents.png
  199. BIN {_static → source/images}/Console_0.7.3/home_console.png
  200. BIN {_static → source/images}/Console_0.7.3/login.png
  201. BIN {_static/Console_0.7.2 → source/images/Console_0.7.3}/new_asset.png
  202. BIN {_static → source/images}/Console_0.7.3/news.png
  203. BIN {_static → source/images}/Console_0.7.3/settings.png
  204. BIN {_static → source/images}/Console_0.7.3/social_login1.png
  205. BIN {_static → source/images}/Console_0.7.3/social_login2.png
  206. BIN {_static → source/images}/Console_0.7.3/users.png
  207. BIN source/images/logo.png
  208. +3,599 −0 source/index.md
  209. +2 −0 source/javascripts/all.js
  210. +1,025 −0 source/javascripts/jquery.tocify.js
  211. +6 −0 source/javascripts/jquery_ui.js
  212. +52 −0 source/javascripts/lang_selector.js
  213. +127 −0 source/layouts/layout.erb
  214. +95 −0 source/stylesheets/fix.css
  215. +50 −0 source/stylesheets/icon-font.scss
  216. +375 −0 source/stylesheets/normalize.css
  217. +110 −0 source/stylesheets/print.css.scss
  218. +470 −0 source/stylesheets/screen.css.scss
  219. +27 −0 source/stylesheets/syntax.css.scss.erb
  220. +106 −0 source/stylesheets/variables.scss
  221. +0 −15 tutorial.rst
View
BIN .DS_Store
Binary file not shown.
View
@@ -1 +0,0 @@
-_build/
View
@@ -1,73 +0,0 @@
-Hacking
-=======
-
-You can override many default value and options by providing them to the
-JVM. To do so, you have to use the **-D** parameter in this way
-
-::
-
- ./start -DBAASBOX_PARAMETER=NEW_VALUE
-
-Where *BAASBOX*\ PARAMETER\_ is the key of the parameter to override and
-*NEW*\ VALUE\_ is the value you want to use. Please note that there is
-no space between the D and the name parameter. Overridable keys are:
-
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-| Key | Description | Example |
-+=======================+==================================================================================================================================================================================================+========================================================================================+
-| http.port | The port used by BaasBox | -Dhttp.port=80 |
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-| https.port | The SSL port used by BaasBox. By default SSL is disabled | -Dhttp.port=443 |
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-| application.code | Your Application Code. You should override the default one and choose a very unique code | -Dapplication.code=Zh54re3 |
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-| orient.baasbox.path | The path of the embedded database. By default this is {BAASBOX\_HOME/db/baasbox} | -Dorient.baasbox.path=./mydb |
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-| logger.application | The default level of the logger. By default is DEBUG. Possible values are ERROR, WARNING, INFO, DEBUG, TRACE | -Dlogger.application=INFO |
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-| config.file | An external configuration file. You can put all your parameters in a file. This file **MUST** include the **include classpath("application.conf")** directive, otherwise BaasBox will not work | -Dconfig.file=baasbox.config then you have to create a file named **baasbox.config** |
-+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
-
-Regarding the config.file key, a possible example of an external
-configuration file may be:
-
-::
-
- include classpath("application.conf")
- application.code="1234-56789"
- orient.baasbox.path=db/baasbox
- logger.application=DEBUG
-
-The Play! Framework
-~~~~~~~~~~~~~~~~~~~
-
-BaasBox is built on top of [[Play!
-Framework\|http://www.playframework.com/]]. Because of this you have to
-download a [[JDK 6 or
-above\|http://www.oracle.com/technetwork/java/javase/downloads/index.html]]
-N.B.(JDK not JRE!) and [[Play!
-2.1.1\|http://www.playframework.com/download]] at this link, and install
-them following their installation guides. You must also download the
-BaasBox source code source from its [[GitHub
-Repo\|https://github.com/baasbox/baasbox]]. Once all the required
-software is correctly installed, and the BaasBox source code is in a
-convenient directory, go to that directory and type **play dist**\
-
-After a while, Play! ends to build the application and a new ./dist
-directory is created in the unzipped BaasBox source code path. In the
-new ./dist directory you will find a zip file containing the compiled
-code. To test it, unzip it in any directory and type ./start (remember
-to set the execution flag). If you are using a Windows system, you need
-a .bat file. Just create a new start.bat file and place the following
-line in it: \*\*java %1 -cp “./lib/\*
-play.core.server.NettyServer.\*\*
-
-(Pay attention to to the final dot)
-
-Since BaasBox is based upon the [[Play! Framework
-2.1\|http://www.playframework.com/download]], many configuration options
-available by Play! could be used with BaasBox. Please refer to the
-[[Play!
-documentation\|http://www.playframework.com/documentation/2.1.x/Configuration]]
-to know how to perform such operations and to customize the default
-behavior.
View
@@ -1,7 +0,0 @@
-Contents:
-
-ADVANCED
--------
-.. toctree::
-
- hacking
View
29 Gemfile
@@ -0,0 +1,29 @@
+# If you have OpenSSL installed, we recommend updating
+# the following line to use "https"
+source 'http://rubygems.org'
+
+gem "middleman", "~>3.2.0"
+
+# For syntax highlighting
+gem "middleman-syntax"
+
+# Plugin for middleman to generate Github pages
+gem 'middleman-gh-pages'
+
+# Live-reloading plugin
+gem "middleman-livereload", "~> 3.1.0"
+
+gem 'redcarpet', :git => 'https://github.com/vmg/redcarpet.git'
+
+# For faster file watcher updates on Windows:
+gem "wdm", "~> 0.1.0", :platforms => [:mswin, :mingw]
+
+# Failed to start middleman without this
+gem "therubyracer"
+
+# Cross-templating language block fix for Ruby 1.8
+platforms :mri_18 do
+ gem "ruby18_source_location"
+end
+
+gem "rake", "~> 10.1.0"
View
13 LICENSE
@@ -0,0 +1,13 @@
+Copyright 2008-2013 Concur Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may
+not use this file except in compliance with the License. You may obtain
+a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.
View
153 Makefile
@@ -1,153 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " singlehtml to make a single large HTML file"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " devhelp to make HTML files and a Devhelp project"
- @echo " epub to make an epub"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
- @echo " text to make text files"
- @echo " man to make manual pages"
- @echo " texinfo to make Texinfo files"
- @echo " info to make Texinfo files and run them through makeinfo"
- @echo " gettext to make PO message catalogs"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
- @echo
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/baasbox.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/baasbox.qhc"
-
-devhelp:
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
- @echo
- @echo "Build finished."
- @echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/baasbox"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/baasbox"
- @echo "# devhelp"
-
-epub:
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
- @echo
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
- "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo "Running LaTeX files through pdflatex..."
- $(MAKE) -C $(BUILDDIR)/latex all-pdf
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
- @echo
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
- @echo
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo
- @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
- @echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-info:
- $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
- @echo "Running Texinfo files through makeinfo..."
- make -C $(BUILDDIR)/texinfo info
- @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
- $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
- @echo
- @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
View
@@ -0,0 +1,5 @@
+docs
+====
+
+BaasBox documentation
+See: [http://www.baasbox.com/documentation](http://www.baasbox.com/documentation)
View
@@ -0,0 +1,3 @@
+require 'middleman-gh-pages'
+
+task :default => [:build]
View
Binary file not shown.
View
Binary file not shown.
@@ -1,10 +0,0 @@
-Application Settings
-================
-
-These APIs can be used to set some internal settings.
-
-Note that many of
-these settings are App-related and do not affect server behavior or
-configuration (like for example the listening port). Server related
-settings must be configured via configuration file, or by hacking the
-start script.
Oops, something went wrong.

0 comments on commit 60d7af6

Please sign in to comment.