dabodoc Commit
Revision 62
Date: 2011-02-27 02:12:42 -0800 (Sun, 27 Feb 2011)
Author: Werner
Trac: http://trac.dabodev.com/changeset/62
Changed:
_U trunk/api/sphinx/build/
U trunk/api/sphinx/config.py
U trunk/api/sphinx/make.bat
U trunk/api/sphinx/source/conf.py
Log:
- changes to allow Dabo package be elsewhere on the system, i.e. not
necessarily below dabodoc\api
Diff:
Property changes on: trunk/api/sphinx/build
___________________________________________________________________
Name: svn:ignore
- htmlhelp
pdf
+ html
htmlhelp
pdf
Modified: trunk/api/sphinx/config.py
===================================================================
--- trunk/api/sphinx/config.py 2011-02-26 14:14:56 UTC (rev 61)
+++ trunk/api/sphinx/config.py 2011-02-27 10:12:42 UTC (rev 62)
@@ -7,11 +7,12 @@
# folder where .rst files will be stored
baseFolder = os.getcwd()
+
docFolder = os.path.join(baseFolder, "source")
# used to generate files, only changed and new ones will be copied to docFolder
# this speeds up the Sphinx build
rstTempFolder = os.path.join(baseFolder, "tempsource")
-folderToDoc = os.path.join(baseFolder, "../dabo")
+folderToDoc = r"c:\dev\dabo\dabo"
if platform.system() == "Windows":
sphinxBuildCmd = "C:\\Python26\\Scripts\\sphinx-build.exe"
@@ -34,9 +35,10 @@
# supported builders
normalHtml = "html"
helpHtml = "htmlhelp"
+singleHtml = "singlehtml"
pdfDoc = "pdf" # doesn't work yet
-validBuilders = [normalHtml, helpHtml]
+validBuilders = [normalHtml, helpHtml, singleHtml, pdfDoc]
# match entry in conf.py for htmlhelp_basename
hhpName = "dabo.hhp"
Modified: trunk/api/sphinx/make.bat
===================================================================
--- trunk/api/sphinx/make.bat 2011-02-26 14:14:56 UTC (rev 61)
+++ trunk/api/sphinx/make.bat 2011-02-27 10:12:42 UTC (rev 62)
@@ -21,6 +21,7 @@
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 using rst2pdf
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
@@ -63,6 +64,12 @@
goto end
)
+if "%1" == "pdf" (
+ %SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/pdf.
+ goto end
+)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
echo.
Modified: trunk/api/sphinx/source/conf.py
===================================================================
--- trunk/api/sphinx/source/conf.py 2011-02-26 14:14:56 UTC (rev 61)
+++ trunk/api/sphinx/source/conf.py 2011-02-27 10:12:42 UTC (rev 62)
@@ -33,10 +33,11 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath("c:\dev\dabo\doc"))
-sys.path.append(os.path.abspath("c:\dev\dabo"))
+sys.path.append(os.path.abspath(r"C:\dev\dabodoc\api\sphinx"))
+sys.path.append(os.path.abspath(r"c:\dev\dabo"))
sys.path.append("sphinxext")
+print sys.path
# need to force it into English
# not just for getting English only doc, but also due to encoding issues when
not
# running with utf-8 encoding
@@ -297,7 +298,7 @@
#pdf_inline_footnotes = True
# verbosity level. 0 1 or 2
-#pdf_verbosity = 0
+pdf_verbosity = 1
# If false, no index is generated.
#pdf_use_index = True
_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/dabo-dev
Searchable Archives: http://leafe.com/archives/search/dabo-dev
This message:
http://leafe.com/archives/byMID/[email protected]
