Skip to content

Commit 598153e

Browse files
danimodanimo
committed
Add Windows enablers for documentation
1 parent a7e94f7 commit 598153e

17 files changed

+3843
-11
lines changed

‎admin_manual/Create HTML.lnk

2.36 KB
Binary file not shown.

‎admin_manual/Create PDF.lnk

2.16 KB
Binary file not shown.

‎admin_manual/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
# Add any Sphinx extension module names here, as strings. They can be extensions
2727
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo']
28+
extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder']
2929

3030

3131
# Add any paths that contain templates here, relative to this directory.
@@ -210,6 +210,10 @@
210210
# If false, no module index is generated.
211211
#latex_domain_indices = True
212212

213+
# -- Options for pdf page output -----------------------------------------------
214+
215+
pdf_documents = [('index', u'owncloudAdminManual', u'ownCloud Admin Manual',
216+
u'The ownCloud developers'),]
213217

214218
# -- Options for manual page output --------------------------------------------
215219

‎admin_manual/make.bat

+9
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ if "%1" == "help" (
2121
echo. html to make standalone HTML files
2222
echo. dirhtml to make HTML files named index.html in directories
2323
echo. singlehtml to make a single large HTML file
24+
echo. pdf to make a PDF file with rst2pdf
2425
echo. pickle to make pickle files
2526
echo. json to make JSON files
2627
echo. htmlhelp to make HTML files and a HTML help project
@@ -68,6 +69,14 @@ if "%1" == "singlehtml" (
6869
goto end
6970
)
7071

72+
if "%1" == "pdf" (
73+
%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
74+
if errorlevel 1 exit /b 1
75+
echo.
76+
echo.Build finished. The PDF file is in %BUILDDIR%/pdf.
77+
goto end
78+
)
79+
7180
if "%1" == "pickle" (
7281
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
7382
if errorlevel 1 exit /b 1

‎developer_manual/Create HTML.lnk

2.36 KB
Binary file not shown.

‎developer_manual/Create PDF.lnk

2.16 KB
Binary file not shown.

‎developer_manual/conf.py

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22
#
33
# ownCloud Documentation documentation build configuration file, created by
4-
# sphinx-quickstart on Mon Oct 22 23:16:40 2012.
4+
# sphinx-quickstart on Mon Oct 22 23:16:40 2012-2014.
55
#
66
# This file is execfile()d with the current directory set to its containing dir.
77
#
@@ -25,7 +25,7 @@
2525

2626
# Add any Sphinx extension module names here, as strings. They can be extensions
2727
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo']
28+
extensions = ['sphinxcontrib.phpdomain', 'sphinx.ext.todo', 'rst2pdf.pdfbuilder']
2929

3030
# Add any paths that contain templates here, relative to this directory.
3131
templates_path = ['../_shared_assets/templates']
@@ -41,7 +41,7 @@
4141

4242
# General information about the project.
4343
project = u'ownCloud Developer Manual'
44-
copyright = u'2012-2013, The ownCloud developers'
44+
copyright = u'2012-2014, The ownCloud developers'
4545

4646
# The version info for the project you're documenting, acts as replacement for
4747
# |version| and |release|, also used in various other places throughout the
@@ -166,7 +166,7 @@
166166
#html_file_suffix = None
167167

168168
# Output file base name for HTML help builder.
169-
htmlhelp_basename = 'ownCloudDeveloperManual'
169+
htmlhelp_basename = '2012-2014'
170170

171171

172172
# -- Options for LaTeX output --------------------------------------------------
@@ -209,6 +209,10 @@
209209
# If false, no module index is generated.
210210
#latex_domain_indices = True
211211

212+
# -- Options for pdf page output -----------------------------------------------
213+
214+
pdf_documents = [('index', u'2012-2014', u'ownCloud Developer Manual',
215+
u'The ownCloud developers'),]
212216

213217
# -- Options for manual page output --------------------------------------------
214218

@@ -250,7 +254,7 @@
250254
epub_title = u'ownCloud Developer Manual'
251255
epub_author = u'The ownCloud developers'
252256
epub_publisher = u'The ownCloud developers'
253-
epub_copyright = u'2012-2013, The ownCloud developers'
257+
epub_copyright = u'2012-2014, The ownCloud developers'
254258

255259
# The language of the text. It defaults to the language option
256260
# or en if the language is not set.

‎developer_manual/make.bat

+9
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ if "%1" == "help" (
2121
echo. html to make standalone HTML files
2222
echo. dirhtml to make HTML files named index.html in directories
2323
echo. singlehtml to make a single large HTML file
24+
echo. pdf to make a PDF file with rst2pdf
2425
echo. pickle to make pickle files
2526
echo. json to make JSON files
2627
echo. htmlhelp to make HTML files and a HTML help project
@@ -68,6 +69,14 @@ if "%1" == "singlehtml" (
6869
goto end
6970
)
7071

72+
if "%1" == "pdf" (
73+
%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
74+
if errorlevel 1 exit /b 1
75+
echo.
76+
echo.Build finished. The PDF file is in %BUILDDIR%/pdf.
77+
goto end
78+
)
79+
7180
if "%1" == "pickle" (
7281
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
7382
if errorlevel 1 exit /b 1

‎setup.cmd

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
@echo off
2+
set WIN32PATH=%CD%\win32
3+
set PATH=%PATH%;%WIN32PATH%
4+
set OLDDIR=%CD%
5+
set TMPDIR=%TEMP%\sphinx-install
6+
7+
if defined ProgramFiles(x86) (
8+
set msi="python-2.7.6.amd64.msi"
9+
) else (
10+
set msi="python-2.7.6.msi"
11+
)
12+
13+
set PYTHONURL="http://www.python.org/ftp/python/2.7.6/%msi%"
14+
set EZSETUPURL="http://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py"
15+
16+
set EASY_INSTALL="C:\Python27\Scripts\easy_install"
17+
18+
rmdir /s /q %TMPDIR%
19+
mkdir %TMPDIR%
20+
cd %TMPDIR%
21+
22+
echo Fetching Python...
23+
wget %PYTHONURL%
24+
echo Fetching Python Easy Setup...
25+
wget --ca-certificate=%WIN32PATH%\ca-bundle.crt %EZSETUPURL%
26+
echo Fetching RST2PDF...
27+
wget --ca-certificate=%WIN32PATH%\ca-bundle.crt %RST2PDFURL%
28+
29+
echo Installing Python...
30+
msiexec /i %msi% /qb ADDLOCAL="Extensions" ADDLOCAL="Tools" ALLUSERS=1
31+
32+
echo Installing Python Easy Setup...
33+
C:\Python27\python.exe ez_setup.py
34+
35+
echo Installing Sphinx...
36+
%EASY_INSTALL% -U sphinx
37+
echo Installing RST2PDF...
38+
%EASY_INSTALL% -U rst2pdf
39+
echo Installing Sphinx PHP Domain...
40+
%EASY_INSTALL% -U sphinxcontrib-phpdomain
41+
42+
echo Setting SPHINXBUILD variable...
43+
setx SPHINXBUILD C:\Python27\Scripts\sphinx-build.exe
44+
45+
echo Removing temporary directory...
46+
cd %OLDDIR%
47+
rmdir /s /q %TMPDIR%
48+
echo Done!
49+
pause
50+

‎user_manual/Create HTML.lnk

2.36 KB
Binary file not shown.

‎user_manual/Create PDF.lnk

2.16 KB
Binary file not shown.

‎user_manual/conf.py

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# -*- coding: utf-8 -*-
22
#
33
# ownCloud Documentation documentation build configuration file, created by
4-
# sphinx-quickstart on Mon Oct 22 23:16:40 2012.
4+
# sphinx-quickstart on Mon Oct 22 23:16:40 2012-2014.
55
#
66
# This file is execfile()d with the current directory set to its containing dir.
77
#
@@ -25,7 +25,7 @@
2525

2626
# Add any Sphinx extension module names here, as strings. They can be extensions
2727
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ['sphinx.ext.todo']
28+
extensions = ['sphinx.ext.todo', 'rst2pdf.pdfbuilder']
2929

3030
# Add any paths that contain templates here, relative to this directory.
3131
templates_path = ['../_shared_assets/templates']
@@ -41,7 +41,7 @@
4141

4242
# General information about the project.
4343
project = u'ownCloud User Manual'
44-
copyright = u'2012-2013, The ownCloud developers'
44+
copyright = u'2012-2014, The ownCloud developers'
4545

4646
# The version info for the project you're documenting, acts as replacement for
4747
# |version| and |release|, also used in various other places throughout the
@@ -209,13 +209,16 @@
209209
# If false, no module index is generated.
210210
#latex_domain_indices = True
211211

212+
# -- Options for pdf page output -----------------------------------------------
213+
214+
pdf_documents = [('index', u'owncloudUserManual', u'ownCloud User Manual', u'The ownCloud developers'),]
212215

213216
# -- Options for manual page output --------------------------------------------
214217

215218
# One entry per manual page. List of tuples
216219
# (source start file, name, description, authors, manual section).
217220
man_pages = [
218-
('contents', 'owncloudadminmanual', u'ownCloud User Manual',
221+
('contents', 'owncloudusermanual', u'ownCloud User Manual',
219222
[u'The ownCloud developers'], 1)
220223
]
221224

@@ -250,7 +253,7 @@
250253
epub_title = u'ownCloud User Manual'
251254
epub_author = u'The ownCloud developers'
252255
epub_publisher = u'The ownCloud developers'
253-
epub_copyright = u'2012-2013, The ownCloud developers'
256+
epub_copyright = u'2012-2014, The ownCloud developers'
254257

255258
# The language of the text. It defaults to the language option
256259
# or en if the language is not set.

‎user_manual/html.txt

Whitespace-only changes.

‎user_manual/make.bat

+9
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ if "%1" == "help" (
2121
echo. html to make standalone HTML files
2222
echo. dirhtml to make HTML files named index.html in directories
2323
echo. singlehtml to make a single large HTML file
24+
echo. pdf to make a PDF file with rst2pdf
2425
echo. pickle to make pickle files
2526
echo. json to make JSON files
2627
echo. htmlhelp to make HTML files and a HTML help project
@@ -68,6 +69,14 @@ if "%1" == "singlehtml" (
6869
goto end
6970
)
7071

72+
if "%1" == "pdf" (
73+
%SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
74+
if errorlevel 1 exit /b 1
75+
echo.
76+
echo.Build finished. The PDF file is in %BUILDDIR%/pdf.
77+
goto end
78+
)
79+
7180
if "%1" == "pickle" (
7281
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
7382
if errorlevel 1 exit /b 1

‎win32/README.txt

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

0 commit comments

Comments
 (0)