changes to support SDK builds (both the actual text, and instructions on how to enable changes when needed)

site/source/conf.py

@@ -90,9 +90,9 @@ copyright = u'2014, '
 # built documents.
 #
 # The short X.Y version.
-version = '1.20'
+version = '1.23'
 # The full version, including alpha/beta/rc tags.
-release = '1.20.0'
+release = '1.23.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -395,4 +395,7 @@ primary_domain = 'cpp'
 # HamishW - tell Breathe about projects. Breathe is tool to convert Doxygen to Python objects, for import into Sphinx.
 #breathe_projects = { "myproject": "/home/me/docproj/doxyxml/", "nutshell":"./headers/xml/", }
 # HamishW - Specify a default project:
-#breathe_default_project = "nutshell"
+#breathe_default_project = "nutshell"
+
+# Comment/uncomment the line below for normal/SDK builds. 
+#tags.add('sdkbuild')

site/source/docs/site/about.rst

@@ -60,14 +60,7 @@ The site sources are stored on Github `here <https://github.com/kripken/emscript
 
 The site is published to the **kripken/emscripten-site** *gh-pages* branch (Github pages).
 
-
-make html
----------
-
-The site can be built from source on Ubuntu and Windows by navigating to the */emscripten/site* directory and using the command: ::
-
-	make clean
-	make html
+.. note:: Remember to update the :ref:`about-build-versions` for *public* builds.
 
 Installing Sphinx
 -----------------
@@ -83,8 +76,54 @@ The workaround is to use the Python package installer "pip" to get version 1.2.2
 
 	pip install sphinx
 	pip install sphinx --upgrade
+	
+
+.. _about-site-builds:
+
+Site builds
+-----------
+
+The site can be built from source on Ubuntu and Windows by navigating to the */emscripten/site* directory and using the command: ::
+
+	make clean
+	make html
+	
+
+.. _about-sdk-builds:
+
+SDK Builds
+------------------
+
+SDK builds are virtually identical to :ref:`about-site-builds`. The main difference is that on SDK builds the :ref:`home page <home-page>` has a clear notification that it is an SDK build.
+
+SDK builds are enabled by adding the ``sdkbuild`` tag in `conf.py <https://github.com/kripken/emscripten/blob/incoming/site/source/conf.py#L400>`_: ::
+
+	#The line below must be uncommented for SDK builds. 
+	tags.add('sdkbuild')
 
 
+.. note:: In theory it should be possible to supply the ``sdkbuild`` tag as a command line option as shown below. However this is not working: 
+
+	::
+
+		make html SPHINXOPTS="-t sdkbuild"
+
+	
+.. _about-build-versions:
+
+Build version
+-------------
+
+The documentation version should match the Emscripten version for the current build. For a general site build this will be the latest tagged release as defined in `Emscripten version <https://github.com/kripken/emscripten/blob/incoming/emscripten-version.txt>`_. For an SDK build it will be the Emscripten version for the SDK.
+
+The version and release information is used in a few places in the documentation, for example :ref:`emscripten-authors`.
+
+The version is set in `conf.py <https://github.com/kripken/emscripten/blob/incoming/site/source/conf.py#L88>`_ in the ``version`` and ``release`` values. For example: ::
+
+	# The short X.Y version.
+	version = '1.23'
+	# The full version, including alpha/beta/rc tags.
+	release = '1.23.0'
 
 .. _writing-and-updating-articles:
 

site/source/index.rst

@@ -1,9 +1,18 @@
+.. _home-page:
+
 .. Emscripten documentation master file, created by
    sphinx-quickstart on Tue Jul 01 09:20:29 2014.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+.. only:: sdkbuild
+
+	.. admonition:: Welcome to Emscripten SDK |release|
+
+		This documentation contains everything you need to :ref:`start developing <Tutorial>` with the Emscripten SDK.
+
 .. warning:: This site is still under construction. 
+
    
 .. raw:: html
    :file: home_page_layout.html
@@ -34,4 +43,3 @@ News
 	docs/tools_reference/index
 	docs/site/about
 
-