Compare commits

...

5 Commits
1.3.0 ... 1.3.1

Author SHA1 Message Date
Bastian Venthur
7e8f2a5b9a prepare new version 2022-06-10 07:27:24 +02:00
Bastian Venthur
d942bf150c install man page 2022-06-09 22:23:12 +02:00
Bastian Venthur
48cfb49acb generate man page in debian package 2022-06-09 22:22:03 +02:00
Bastian Venthur
c3edbeb511 cleanup generated doc files in makefile 2022-06-09 21:52:34 +02:00
Bastian Venthur
a60887e0d6 small yaml fix m( 2022-06-09 21:44:27 +02:00
11 changed files with 20 additions and 193 deletions

View File

@@ -17,8 +17,8 @@ jobs:
- macos-latest
- windows-latest
python-version:
- 3.8
- 3.9
- "3.8"
- "3.9"
- "3.10"
steps:

3
.gitignore vendored
View File

@@ -5,6 +5,9 @@ build/
dist/
*.egg-info/
docs/_build/
docs/api/
htmlcov/
.coverage

View File

@@ -1,5 +1,9 @@
# Changelog
## [1.3.1] - 2022-06-10
* fixed man page
## [1.3.0] - 2022-06-09
* debianized package

View File

@@ -46,6 +46,7 @@ clean:
rm -rf build dist *.egg-info
rm -rf $(VENV)
rm -rf $(DOCS_OUT)
rm -rf $(DOCS_SRC)/api
find . -type f -name *.pyc -delete
find . -type d -name __pycache__ -delete
# coverage

View File

@@ -1 +1 @@
__VERSION__ = '1.3.0'
__VERSION__ = '1.3.1'

View File

@@ -1,6 +0,0 @@
blag for Debian
--------------
<Possible notes regarding this package - if none, delete this file.>
-- Bastian Venthur <venthur@debian.org> Sun, 05 Jun 2022 15:20:48 +0200

1
debian/blag.install vendored Normal file
View File

@@ -0,0 +1 @@
build/man/blag.1 /usr/share/man/man1

6
debian/changelog vendored
View File

@@ -1,3 +1,9 @@
blag (1.3.1) unstable; urgency=medium
* re-upload with man pages
-- Bastian Venthur <venthur@debian.org> Fri, 10 Jun 2022 07:26:19 +0200
blag (1.3.0) unstable; urgency=medium
* Initial release. Closes: #1012584

56
debian/manpage.1.ex vendored
View File

@@ -1,56 +0,0 @@
.\" Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2022 Bastian Venthur <venthur@debian.org>,
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH Blag SECTION "June 5 2022"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
blag \- program to do something
.SH SYNOPSIS
.B blag
.RI [ options ] " files" ...
.br
.B bar
.RI [ options ] " files" ...
.SH DESCRIPTION
This manual page documents briefly the
.B blag
and
.B bar
commands.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBblag\fP is a program that...
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes ('-').
A summary of options is included below.
For a complete description, see the Info files.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-v, \-\-version
Show version of program.
.SH SEE ALSO
.BR bar (1),
.BR baz (1).
.br
The programs are documented fully by
.IR "The Rise and Fall of a Fooish Bar" ,
available via the Info system.

126
debian/manpage.md.ex vendored
View File

@@ -1,126 +0,0 @@
% blag(SECTION) | User Commands
%
% "June 5 2022"
[comment]: # The lines above form a Pandoc metadata block. They must be
[comment]: # the first ones in the file.
[comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details.
[comment]: # pandoc -s -f markdown -t man package.md -o package.1
[comment]: #
[comment]: # A manual page package.1 will be generated. You may view the
[comment]: # manual page with: nroff -man package.1 | less. A typical entry
[comment]: # in a Makefile or Makefile.am is:
[comment]: #
[comment]: # package.1: package.md
[comment]: # pandoc --standalone --from=markdown --to=man $< --output=$@
[comment]: #
[comment]: # The pandoc binary is found in the pandoc package. Please remember
[comment]: # that if you create the nroff version in one of the debian/rules
[comment]: # file targets, such as build, you will need to include pandoc in
[comment]: # your Build-Depends control field.
[comment]: # Remove the lines starting with '[comment]:' in this file in order
[comment]: # to avoid warning messages from pandoc.
# NAME
blag - program to do something
# SYNOPSIS
**blag** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
[{**-e** | **\-\-example**} {_this_ | _that_}]
**blag** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]
# DESCRIPTION
This manual page documents briefly the **blag** and **bar** commands.
This manual page was written for the Debian distribution because the
original program does not have a manual page. Instead, it has documentation
in the GNU info(1) format; see below.
**blag** is a program that...
# OPTIONS
The program follows the usual GNU command line syntax, with long options
starting with two dashes ('-'). A summary of options is included below. For
a complete description, see the **info**(1) files.
**-e** _this_, **\-\-example=**_that_
: Does this and that.
**-h**, **\-\-help**
: Show summary of options.
**-v**, **\-\-version**
: Show version of program.
# FILES
/etc/foo.conf
: The system-wide configuration file to control the behaviour of
blag. See **foo.conf**(5) for further details.
${HOME}/.foo.conf
: The per-user configuration file to control the behaviour of
blag. See **foo.conf**(5) for further details.
# ENVIRONMENT
**FOO_CONF**
: If used, the defined file is used as configuration file (see also
the section called FILES).
# DIAGNOSTICS
The following diagnostics may be issued on stderr:
Bad configuration file. Exiting.
: The configuration file seems to contain a broken configuration
line. Use the **\-\-verbose** option, to get more info.
**blag** provides some return codes, that can be used in scripts:
Code Diagnostic
0 Program exited successfully.
1 The configuration file seems to be broken.
# BUGS
The program is currently limited to only work with the foobar library.
The upstream BTS can be found at http://bugzilla.foo.tld.
# SEE ALSO
**bar**(1), **baz**(1), **foo.conf**(5)
The programs are documented fully by The Rise and Fall of a Fooish Bar
available via the **info**(1) system.
# AUTHOR
Bastian Venthur <venthur@debian.org>
: Wrote this manpage for the Debian system.
# COPYRIGHT
Copyright © 2007 Bastian Venthur
This manual page was written for the Debian system (and may be used by
others).
Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU General Public License, Version 2 or (at your option)
any later version published by the Free Software Foundation.
On Debian systems, the complete text of the GNU General Public License
can be found in /usr/share/common-licenses/GPL.
[comment]: # Local Variables:
[comment]: # mode: markdown
[comment]: # End:

4
debian/rules vendored
View File

@@ -21,5 +21,5 @@ execute_after_dh_auto_build-indep: export https_proxy=127.0.0.1:9
execute_after_dh_auto_build-indep:
PYTHONPATH=. python3 -m sphinx -N -bhtml \
docs/ build/html # HTML generator
# PYTHONPATH=. python3 -m sphinx -N -bman \
# docs/ build/man # Manpage generator
PYTHONPATH=. python3 -m sphinx -N -bman \
docs/ build/man # Manpage generator