[Liblas-commits] hg-main-tree: add Sphinx build setup
liblas-commits at liblas.org
liblas-commits at liblas.org
Tue Mar 15 16:33:27 EDT 2011
details: http://hg.libpc.orghg-main-tree/rev/d6454814cc00
changeset: 248:d6454814cc00
user: Howard Butler <hobu.inc at gmail.com>
date: Tue Mar 15 15:32:41 2011 -0500
description:
add Sphinx build setup
Subject: hg-main-tree: merge
details: http://hg.libpc.orghg-main-tree/rev/86d3959da0f3
changeset: 249:86d3959da0f3
user: Howard Butler <hobu.inc at gmail.com>
date: Tue Mar 15 15:33:04 2011 -0500
description:
merge
diffstat:
.hgignore | 1 +
apps/Application.cpp | 2 +-
apps/pc2pc.cpp | 36 ++--
apps/pcinfo.cpp | 4 +-
doc/Makefile | 130 ++++++++++++++
doc/conf.py | 256 +++++++++++++++++++++++++++++
doc/index.txt | 37 ++++
doc/make.bat | 170 +++++++++++++++++++
doc/notes/apps.txt | 2 +
doc/notes/bindings.txt | 2 +
doc/notes/c-api.txt | 2 +
doc/notes/coding-conventions.txt | 2 +
doc/notes/core-classes.txt | 2 +
doc/notes/docs.txt | 2 +
doc/notes/future.txt | 2 +
doc/notes/goals.txt | 2 +
doc/notes/intro.txt | 2 +
doc/notes/io.txt | 2 +
doc/notes/misc.txt | 2 +
doc/notes/pipeline.txt | 2 +
doc/notes/stages.txt | 2 +
doc/notes/testing.txt | 2 +
doc/notes/use-cases.txt | 2 +
doc/sprint/notes.txt | 6 +
include/libpc/CacheFilter.hpp | 94 ----------
include/libpc/ColorFilter.hpp | 66 -------
include/libpc/CropFilter.hpp | 65 -------
include/libpc/DecimationFilter.hpp | 64 -------
include/libpc/MosaicFilter.hpp | 66 -------
include/libpc/SpatialReference.hpp | 2 +-
include/libpc/filters/CacheFilter.hpp | 94 ++++++++++
include/libpc/filters/ColorFilter.hpp | 66 +++++++
include/libpc/filters/CropFilter.hpp | 65 +++++++
include/libpc/filters/DecimationFilter.hpp | 64 +++++++
include/libpc/filters/MosaicFilter.hpp | 66 +++++++
src/CMakeLists.txt | 39 ++--
src/CacheFilter.cpp | 172 -------------------
src/ColorFilter.cpp | 114 ------------
src/CropFilter.cpp | 98 -----------
src/DecimationFilter.cpp | 79 --------
src/MosaicFilter.cpp | 149 ----------------
src/SpatialReference.cpp | 2 +-
src/drivers/las/LasHeaderWriter.cpp | 2 +-
src/filters/CMakeLists.txt | 23 ++
src/filters/CacheFilter.cpp | 172 +++++++++++++++++++
src/filters/ColorFilter.cpp | 114 ++++++++++++
src/filters/CropFilter.cpp | 98 +++++++++++
src/filters/DecimationFilter.cpp | 79 ++++++++
src/filters/MosaicFilter.cpp | 149 ++++++++++++++++
test/unit/CacheFilterTest.cpp | 4 +-
test/unit/CropFilterTest.cpp | 6 +-
test/unit/DecimationFilterTest.cpp | 6 +-
test/unit/FauxReaderTest.cpp | 2 +-
test/unit/FauxWriterTest.cpp | 4 +-
test/unit/LiblasReaderTest.cpp | 2 +-
test/unit/LiblasWriterTest.cpp | 6 +-
test/unit/MosaicFilterTest.cpp | 4 +-
test/unit/PointDataCacheTest.cpp | 4 +-
test/unit/PointDataTest.cpp | 2 +-
test/unit/RangeTest.cpp | 2 +-
test/unit/SchemaLayoutTest.cpp | 2 +-
test/unit/SchemaTest.cpp | 2 +-
test/unit/SignallerTest.cpp | 2 +-
test/unit/UtilsTest.cpp | 2 +-
test/unit/VectorTest.cpp | 2 +-
65 files changed, 1690 insertions(+), 1036 deletions(-)
diffs (truncated from 3227 to 300 lines):
diff -r 40be85a9bd1d -r 86d3959da0f3 .hgignore
--- a/.hgignore Tue Mar 15 14:35:30 2011 -0500
+++ b/.hgignore Tue Mar 15 15:33:04 2011 -0500
@@ -34,3 +34,4 @@
csharp/libpc_swig_cpp/libpc_wrap.cpp
Makefile
+doc/build
diff -r 40be85a9bd1d -r 86d3959da0f3 apps/Application.cpp
--- a/apps/Application.cpp Tue Mar 15 14:35:30 2011 -0500
+++ b/apps/Application.cpp Tue Mar 15 15:33:04 2011 -0500
@@ -36,7 +36,7 @@
#include <boost/timer.hpp>
-#include "libpc/libpc_config.hpp"
+#include <libpc/libpc_config.hpp>
#include "Application.hpp"
diff -r 40be85a9bd1d -r 86d3959da0f3 apps/pc2pc.cpp
--- a/apps/pc2pc.cpp Tue Mar 15 14:35:30 2011 -0500
+++ b/apps/pc2pc.cpp Tue Mar 15 15:33:04 2011 -0500
@@ -12,27 +12,27 @@
#include <iostream>
-#include "libpc/exceptions.hpp"
-//#include "libpc/libpc_config.hpp"
-//#include "libpc/Bounds.hpp"
-//#include "libpc/Color.hpp"
-//#include "libpc/Dimension.hpp"
-//#include "libpc/Schema.hpp"
-//#include "libpc/CropFilter.hpp"
-//#include "libpc/ColorFilter.hpp"
-//#include "libpc/MosaicFilter.hpp"
-//#include "libpc/FauxReader.hpp"
-//#include "libpc/FauxWriter.hpp"
-#include "libpc/drivers/las/Reader.hpp"
-//#include "libpc/LasHeader.hpp"
-#include "libpc/drivers/las/Writer.hpp"
-#include "libpc/CacheFilter.hpp"
+#include <libpc/exceptions.hpp>
+//#include <libpc/libpc_config.hpp>
+//#include <libpc/Bounds.hpp>
+//#include <libpc/Color.hpp>
+//#include <libpc/Dimension.hpp>
+//#include <libpc/Schema.hpp>
+//#include <libpc/CropFilter.hpp>
+//#include <libpc/ColorFilter.hpp>
+//#include <libpc/MosaicFilter.hpp>
+//#include <libpc/FauxReader.hpp>
+//#include <libpc/FauxWriter.hpp>
+#include <libpc/drivers/las/Reader.hpp>
+//#include <libpc/LasHeader.hpp>
+#include <libpc/drivers/las/Writer.hpp>
+#include <libpc/filters/CacheFilter.hpp>
-#include "libpc/drivers/liblas/writer.hpp"
-#include "libpc/drivers/liblas/reader.hpp"
+#include <libpc/drivers/liblas/writer.hpp>
+#include <libpc/drivers/liblas/reader.hpp>
#ifdef HAVE_ORACLE
-#include "libpc/drivers/oci/writer.hpp"
+#include <libpc/drivers/oci/writer.hpp>
#endif
#include "Application.hpp"
diff -r 40be85a9bd1d -r 86d3959da0f3 apps/pcinfo.cpp
--- a/apps/pcinfo.cpp Tue Mar 15 14:35:30 2011 -0500
+++ b/apps/pcinfo.cpp Tue Mar 15 15:33:04 2011 -0500
@@ -10,8 +10,8 @@
**************************************************************************/
-#include "libpc/drivers/las/Reader.hpp"
-#include "libpc/drivers/liblas/reader.hpp"
+#include <libpc/drivers/las/Reader.hpp>
+#include <libpc/drivers/liblas/reader.hpp>
#include <iostream>
diff -r 40be85a9bd1d -r 86d3959da0f3 doc/Makefile
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/Makefile Tue Mar 15 15:33:04 2011 -0500
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @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 " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/libPC.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/libPC.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/libPC"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/libPC"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff -r 40be85a9bd1d -r 86d3959da0f3 doc/conf.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/conf.py Tue Mar 15 15:33:04 2011 -0500
@@ -0,0 +1,256 @@
+# -*- coding: utf-8 -*-
+#
+# libPC documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar 15 15:22:19 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# 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.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'libPC'
+copyright = u'2011, Howard Butler'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
More information about the Liblas-commits
mailing list