[Python-modules-commits] [python-mkdocs] 02/03: Add manpage

[Brian May]

This is an automated email from the git hooks/post-receive script.

bam pushed a commit to branch debian/experimental
in repository python-mkdocs.

commit 36f8eaa47a118742b7f08f11fa2f6c6506ab5741
Author: Brian May <bam at debian.org>
Date:   Sat Mar 11 10:43:18 2017 +1100

    Add manpage
    
    Manpages for all binaries are a policy requirement for all Debian
    packages.
    
    https://www.debian.org/doc/debian-policy/ch-docs.html#s12.1
    
    This commit attempts to address this issue.
---
 debian/mkdocs.1        | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 debian/mkdocs.manpages |  1 +
 2 files changed, 48 insertions(+)

diff --git a/debian/mkdocs.1 b/debian/mkdocs.1
new file mode 100644
index 0000000..c7a572b
--- /dev/null
+++ b/debian/mkdocs.1
@@ -0,0 +1,47 @@
+.TH MKDOCS 1
+
+.SH NAME
+mkdocs \- Project documentation with Markdown
+
+.SH SYNOPSIS
+.B mkdocs
+[\fB\-V\fR]
+[\fB\-q\fR]
+[\fB\-v\fR]
+[\fB\-h\fR]
+.IR command
+
+.SH DESCRIPTION
+.B mkdocs
+builds markdown based project documentation.
+
+.SH OPTIONS
+.TP
+.BR \-V ", " \-\-version
+Show the version and exit.
+.TP
+.BR \-q ", " \-\-quiet
+Show the version and exit.
+.TP
+.BR \-v ", " \-\-verbose
+Enable verbose output.
+.TP
+.BR \-h ", " \-\-help
+Show this message and exit.
+
+.SH COMMANDS
+.TP
+.BR build
+Build the MkDocs documentation.
+.TP
+.BR gh-deploy
+Deploy your documentation to GitHub Pages.
+.TP
+.BR json
+Build the MkDocs documentation to JSON files.
+.TP
+.BR new
+Create a new MkDocs project.
+.TP
+.BR serve
+Run the builtin development server.
diff --git a/debian/mkdocs.manpages b/debian/mkdocs.manpages
new file mode 100644
index 0000000..21cfedf
--- /dev/null
+++ b/debian/mkdocs.manpages
@@ -0,0 +1 @@
+debian/mkdocs.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-mkdocs.git