Friday, November 11, 2011

Building kinterbasdb docs

sudo apt-get install python-sphinx

svn co https://firebird.svn.sourceforge.net/svnroot/firebird/kinterbasdb kinterbasdb

kinterbasdb/trunk/sphinx

make html
mkdir -p .build/html .build/doctrees
sphinx-build -b html -d .build/doctrees   . ../docs
Running Sphinx v1.0.7
loading pickled environment... not yet created
building [html]: targets for 11 source files that are out of date
updating environment: 11 added, 0 changed, 0 removed
reading sources... [100%] tutorial                                                                                                                                                           
/home/mariuz/work/kinterbasdb/trunk/sphinx/beyond-python-db-api.txt:75: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.

/home/mariuz/work/kinterbasdb/trunk/sphinx/beyond-python-db-api.txt:: WARNING: using old C markup; please migrate to new-style markup (e.g. c:function instead of cfunction), see http://sphinx.pocoo.org/domains.html
/home/mariuz/work/kinterbasdb/trunk/sphinx/changelog.txt:950: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

/home/mariuz/work/kinterbasdb/trunk/sphinx/changelog.txt:1158: (WARNING/2) Definition list ends without a blank line; unexpected unindent.

/home/mariuz/work/kinterbasdb/trunk/sphinx/concurrency.txt:167: (WARNING/2) Block quote ends without a blank line; unexpected unindent.

/home/mariuz/work/kinterbasdb/trunk/sphinx/python-db-api-compliance.txt:32: WARNING: duplicate object description of kinterbasdb.Cursor, other instance in /home/mariuz/work/kinterbasdb/trunk/sphinx/beyond-python-db-api.txt, use :noindex: for one of them
/home/mariuz/work/kinterbasdb/trunk/sphinx/python-db-api-compliance.txt:107: WARNING: duplicate object description of kinterbasdb.Connection, other instance in /home/mariuz/work/kinterbasdb/trunk/sphinx/beyond-python-db-api.txt, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] tutorial                                                                                                                                                            
writing additional files... genindex py-modindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 7 warnings.

Build finished. The HTML pages are in .build/html.

No comments: