Add Windows enablers for documentation

admin_manual/conf.py

@@ -25,7 +25,7 @@ import sys, os
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo']
+extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder']
 
 
 # Add any paths that contain templates here, relative to this directory.
@@ -210,6 +210,10 @@ latex_logo = '../_shared_assets/static/logo-blue.pdf'
 # If false, no module index is generated.
 #latex_domain_indices = True
 
+# -- Options for pdf page output -----------------------------------------------
+
+pdf_documents = [('index', u'owncloudAdminManual', u'ownCloud Admin Manual',
+                  u'The ownCloud developers'),]
 
 # -- Options for manual page output --------------------------------------------
 

admin_manual/make.bat

@@ -21,6 +21,7 @@ if "%1" == "help" (
 	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.  pdf        to make a PDF file with rst2pdf
 	echo.  pickle     to make pickle files
 	echo.  json       to make JSON files
 	echo.  htmlhelp   to make HTML files and a HTML help project
@@ -68,6 +69,14 @@ if "%1" == "singlehtml" (
 	goto end
 )
 
+if "%1" == "pdf" (
+	%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The PDF file is in %BUILDDIR%/pdf.
+	goto end
+)
+
 if "%1" == "pickle" (
 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
 	if errorlevel 1 exit /b 1

developer_manual/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # ownCloud Documentation documentation build configuration file, created by
-# sphinx-quickstart on Mon Oct 22 23:16:40 2012.
+# sphinx-quickstart on Mon Oct 22 23:16:40 2012-2014.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -25,7 +25,7 @@ import sys, os
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo']
+extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['../_shared_assets/templates']
@@ -41,7 +41,7 @@ master_doc = 'contents'
 
 # General information about the project.
 project = u'ownCloud Developer Manual'
-copyright = u'2012-2013, The ownCloud developers'
+copyright = u'2012-2014, The ownCloud developers'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -166,7 +166,7 @@ html_show_sphinx = False
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ownCloudDeveloperManual'
+htmlhelp_basename = '2012-2014'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -209,6 +209,10 @@ latex_logo = '../_shared_assets/static/logo-blue.pdf'
 # If false, no module index is generated.
 #latex_domain_indices = True
 
+# -- Options for pdf page output -----------------------------------------------
+
+pdf_documents = [('index', u'2012-2014', u'ownCloud Developer Manual',
+                  u'The ownCloud developers'),]
 
 # -- Options for manual page output --------------------------------------------
 
@@ -250,7 +254,7 @@ texinfo_documents = [
 epub_title = u'ownCloud Developer Manual'
 epub_author = u'The ownCloud developers'
 epub_publisher = u'The ownCloud developers'
-epub_copyright = u'2012-2013, The ownCloud developers'
+epub_copyright = u'2012-2014, The ownCloud developers'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

developer_manual/make.bat

@@ -21,6 +21,7 @@ if "%1" == "help" (
 	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.  pdf        to make a PDF file with rst2pdf
 	echo.  pickle     to make pickle files
 	echo.  json       to make JSON files
 	echo.  htmlhelp   to make HTML files and a HTML help project
@@ -68,6 +69,14 @@ if "%1" == "singlehtml" (
 	goto end
 )
 
+if "%1" == "pdf" (
+	%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The PDF file is in %BUILDDIR%/pdf.
+	goto end
+)
+
 if "%1" == "pickle" (
 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
 	if errorlevel 1 exit /b 1

setup.cmd

@@ -0,0 +1,50 @@
+@echo off
+set WIN32PATH=%CD%\win32
+set PATH=%PATH%;%WIN32PATH%
+set OLDDIR=%CD%
+set TMPDIR=%TEMP%\sphinx-install
+
+if defined ProgramFiles(x86) (
+  set msi="python-2.7.6.amd64.msi"
+) else (
+  set msi="python-2.7.6.msi"
+)
+
+set PYTHONURL="http://www.python.org/ftp/python/2.7.6/%msi%"
+set EZSETUPURL="http://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py"
+
+set EASY_INSTALL="C:\Python27\Scripts\easy_install"
+
+rmdir /s /q %TMPDIR%
+mkdir %TMPDIR%
+cd %TMPDIR%
+
+echo Fetching Python...
+wget %PYTHONURL%
+echo Fetching Python Easy Setup...
+wget --ca-certificate=%WIN32PATH%\ca-bundle.crt %EZSETUPURL%
+echo Fetching RST2PDF...
+wget --ca-certificate=%WIN32PATH%\ca-bundle.crt %RST2PDFURL%
+
+echo Installing Python...
+msiexec /i %msi% /qb ADDLOCAL="Extensions" ADDLOCAL="Tools" ALLUSERS=1
+
+echo Installing Python Easy Setup...
+C:\Python27\python.exe ez_setup.py
+
+echo Installing Sphinx...
+%EASY_INSTALL% -U sphinx
+echo Installing RST2PDF...
+%EASY_INSTALL% -U rst2pdf
+echo Installing Sphinx PHP Domain...
+%EASY_INSTALL% -U sphinxcontrib-phpdomain
+
+echo Setting SPHINXBUILD variable...
+setx SPHINXBUILD C:\Python27\Scripts\sphinx-build.exe
+
+echo Removing temporary directory...
+cd %OLDDIR%
+rmdir /s /q %TMPDIR%
+echo Done!
+pause
+ 

user_manual/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # ownCloud Documentation documentation build configuration file, created by
-# sphinx-quickstart on Mon Oct 22 23:16:40 2012.
+# sphinx-quickstart on Mon Oct 22 23:16:40 2012-2014.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -25,7 +25,7 @@ import sys, os
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.todo']
+extensions = ['sphinx.ext.todo', 'rst2pdf.pdfbuilder']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['../_shared_assets/templates']
@@ -41,7 +41,7 @@ master_doc = 'contents'
 
 # General information about the project.
 project = u'ownCloud User Manual'
-copyright = u'2012-2013, The ownCloud developers'
+copyright = u'2012-2014, The ownCloud developers'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -209,13 +209,16 @@ latex_logo = '../_shared_assets/static/logo-blue.pdf'
 # If false, no module index is generated.
 #latex_domain_indices = True
 
+# -- Options for pdf page output -----------------------------------------------
+
+pdf_documents = [('index', u'owncloudUserManual', u'ownCloud User Manual', u'The ownCloud developers'),]
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('contents', 'owncloudadminmanual', u'ownCloud User Manual',
+    ('contents', 'owncloudusermanual', u'ownCloud User Manual',
      [u'The ownCloud developers'], 1)
 ]
 
@@ -250,7 +253,7 @@ texinfo_documents = [
 epub_title = u'ownCloud User Manual'
 epub_author = u'The ownCloud developers'
 epub_publisher = u'The ownCloud developers'
-epub_copyright = u'2012-2013, The ownCloud developers'
+epub_copyright = u'2012-2014, The ownCloud developers'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

user_manual/make.bat

@@ -21,6 +21,7 @@ if "%1" == "help" (
 	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.  pdf        to make a PDF file with rst2pdf
 	echo.  pickle     to make pickle files
 	echo.  json       to make JSON files
 	echo.  htmlhelp   to make HTML files and a HTML help project
@@ -68,6 +69,14 @@ if "%1" == "singlehtml" (
 	goto end
 )
 
+if "%1" == "pdf" (
+	%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The PDF file is in %BUILDDIR%/pdf.
+	goto end
+)
+
 if "%1" == "pickle" (
 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
 	if errorlevel 1 exit /b 1

win32/README.txt

@@ -0,0 +1,6 @@
+Helper tools for Windows
+------------------------
+
+- wget.exe: Statically compiled wget from 
+  https://code.google.com/p/mingw-and-ndk/downloads/detail?name=wget-1.13.4-static-mingw.7z
+- ca-bundle.crt: Static root bundle from Firefox for use with wget