summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <hun@n-dimensional.de>2008-06-27 02:25:34 +0200
committerHans Ulrich Niedermann <hun@n-dimensional.de>2008-07-15 12:28:54 +0200
commitfdec34d744e03361bb177b171359c4e3e5d23f35 (patch)
tree93642228d7016ff771a838e63d379f45bce8c7c9
parentaee874ee1c445dd581a7bbf5183455b7e9e4e86d (diff)
downloadnbb-fdec34d744e03361bb177b171359c4e3e5d23f35.tar.gz
nbb-fdec34d744e03361bb177b171359c4e3e5d23f35.tar.xz
nbb-fdec34d744e03361bb177b171359c4e3e5d23f35.zip
Generate pydoc docs
-rw-r--r--Makefile.am4
-rw-r--r--configure.ac4
-rw-r--r--src/Makefile-files18
-rw-r--r--src/nbblib/__init__.py2
-rw-r--r--src/nbblib/commands.py5
-rw-r--r--src/nbblib/main.py2
6 files changed, 32 insertions, 3 deletions
diff --git a/Makefile.am b/Makefile.am
index 1e56f8c..c1e1f40 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,5 +1,7 @@
nbblibdir = $(pythondir)/nbblib
+ALL_LOCAL =
+
CLEANFILES =
BUILT_SOURCES =
EXTRA_DIST =
@@ -33,6 +35,8 @@ include build-helpers/package-version.mk
include Makefile-files
include src/Makefile-files
+all-local: $(ALL_LOCAL)
+
if HAVE_NDIM_MAN2TXT
.man.txt:
$(NDIM_MAN2TXT) "$<" > "$@.new"
diff --git a/configure.ac b/configure.ac
index d841877..e54078d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -24,6 +24,10 @@ AM_PATH_PYTHON([2.4], [:],
[AC_MSG_ERROR([nbb does require Python >= 2.4])])
AM_CONDITIONAL([HAVE_PYTHON], [ test "x$PYTHON" != "x:" ])
+AC_ARG_VAR([PYDOC], [pydoc python documentation tool])
+AC_PATH_PROG([PYDOC], [pydoc], [no])
+AM_CONDITIONAL([HAVE_PYDOC], [test "x$PYDOC" != "xno"])
+
########################################################################
m4_pattern_forbid([NDIM_REQUIRE_POSIX_SH])dnl
diff --git a/src/Makefile-files b/src/Makefile-files
index 6707adc..a397c8d 100644
--- a/src/Makefile-files
+++ b/src/Makefile-files
@@ -15,7 +15,7 @@ nbblib_PYTHON += src/nbblib/vcs.py
# Put all python source files, whether changed or verbatim,
# into builddir, such that we can run tests in builddir.
-all-local: all-local-nbblib
+ALL_LOCAL += all-local-nbblib
all-local-nbblib:
@for f in $(nbblib_PYTHON); do \
if test -f "$(top_builddir)/$$f" && test "$(top_srcdir)/$$f" -ot "$(top_builddir)/$$f"; then :; else \
@@ -24,6 +24,22 @@ all-local-nbblib:
fi; \
done
+if HAVE_PYDOC
+ALL_LOCAL += all-local-nbblib-pydoc
+all-local-nbblib-pydoc: all-local-nbblib
+ @cd src && \
+ echo "Entering directory '$$PWD'"; \
+ echo $(PYDOC) -w "nbblib"; \
+ $(PYDOC) -w "nbblib"; \
+ for modfile in nbblib/*.py; do \
+ mod="nbblib.$$(basename "$$modfile" .py)"; \
+ test "$$mod" = "nbblib.__init__" && continue; \
+ echo $(PYDOC) -w "$${mod}"; \
+ $(PYDOC) -w "$${mod}"; \
+ done; \
+ echo "Leaving directory '$$PWD'";
+endif
+
bin_SCRIPTS += src/nbb
CLEANFILES += src/nbb
diff --git a/src/nbblib/__init__.py b/src/nbblib/__init__.py
index 5f4a254..47b0375 100644
--- a/src/nbblib/__init__.py
+++ b/src/nbblib/__init__.py
@@ -5,7 +5,7 @@ import nbblib.package as package
import nbblib.progutils as progutils
import nbblib.vcs as vcs
-from package import PACKAGE_VERSION
+from nbblib.package import PACKAGE_VERSION
__all__ = ['bs', 'commands',
'package', 'plugins',
diff --git a/src/nbblib/commands.py b/src/nbblib/commands.py
index 861b8ba..7ef444b 100644
--- a/src/nbblib/commands.py
+++ b/src/nbblib/commands.py
@@ -1,3 +1,8 @@
+"""\
+nbblib.commands - cmdline command infrastructure and implementation
+Copyright (C) 2008 Hans Ulrich Niedermann <hun@n-dimensional.de>
+"""
+
import os
import sys
import logging
diff --git a/src/nbblib/main.py b/src/nbblib/main.py
index 6e5d6d5..46dbd41 100644
--- a/src/nbblib/main.py
+++ b/src/nbblib/main.py
@@ -28,6 +28,7 @@ DONE:
and then check that the Python environment is actually compatible.
@classmethod -> Python 2.4
new style classes -> Python 2.2
+ * Add pydoc docs.
TODO: (to get git-amb equivalent functionality)
* Fine-tune init, configure, build, install commands with knowledge
@@ -45,7 +46,6 @@ TODO: (Large list)
* Use declarations for command line parsing, and help text generation.
Use optparse stuff for both global params and extra optparse stuff
for each command?
- * Add pydoc docs.
* Add global --nick or similar option to determine the branch
name to use for composing the pathes.
* Find or implement @abstractmethod decorator.