aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/module.mk
diff options
context:
space:
mode:
authorW. Trevor King <wking@drexel.edu>2010-02-08 17:05:12 -0500
committerW. Trevor King <wking@drexel.edu>2010-02-08 17:05:12 -0500
commit37d61e9ecd8768b25ba4aff3c657ccc56f086dd0 (patch)
tree31214efb9536a319473277610534cf2f37215ed1 /doc/man/module.mk
parent3f27c5c3bbc1ecd00db51c4894a9bf9651ae4fbb (diff)
parent960565a8cc80f98d0a8bfa77029fbc78692ea1a1 (diff)
downloadbugseverywhere-37d61e9ecd8768b25ba4aff3c657ccc56f086dd0.tar.gz
Merged initial Sphinx documentation structure.
There's still a long way to go in this direction, but the basic framework is now in place. Toss in numpydoc-style docstrings http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines when you have time, and things will gradually improve over time. I also punted our user ID creation/parsing in libbe.ui.util.user to the email module. This way IDs are handled in an RFC-compliant way (less suprising for users) and by someone else (less work for us :).
Diffstat (limited to 'doc/man/module.mk')
-rw-r--r--doc/man/module.mk44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/man/module.mk b/doc/man/module.mk
new file mode 100644
index 0000000..ea4eacc
--- /dev/null
+++ b/doc/man/module.mk
@@ -0,0 +1,44 @@
+# :vim: filetype=make : -*- makefile; coding: utf-8; -*-
+
+# doc/module.mk
+# Part of Bugs Everywhere, a distributed bug tracking system.
+#
+# Copyright (C) 2008-2010 Chris Ball <cjb@laptop.org>
+# Gianluca Montecchi <gian@grys.it>
+# W. Trevor King <wking@drexel.edu>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# Makefile module for documentation
+
+MODULE_DIR := doc/src
+
+MANPAGES = be.1
+manpage_files = $(patsubst %,${MODULE_DIR}/%,${MANPAGES})
+
+GENERATED_FILES += ${manpage_files}
+
+
+.PHONY: doc
+doc: man
+
+build: doc
+
+
+.PHONY: man
+man: ${manpage_files}
+
+%.1: %.1.sgml
+ docbook-to-man $< > $@