Skip to content

Commit

Permalink
Added machinery to build local deb installations
Browse files Browse the repository at this point in the history
  • Loading branch information
jsseidel committed Feb 13, 2019
1 parent 9ce5819 commit e640387
Show file tree
Hide file tree
Showing 16 changed files with 147 additions and 0 deletions.
17 changes: 17 additions & 0 deletions bin/mktechdocs.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

export MKTECHDOCSHOME=/opt/mktechdocs
export PATH=$PATH:$MKTECHDOCSHOME/bin:$MKTECHDOCSHOME/bin/groovy:.
export PYTHONPATH=$MKTECHDOCSHOME/bin
6 changes: 6 additions & 0 deletions debian/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
The Debian Package mktechdocs
----------------------------

A debian package for easier installation of MkTechDocs

-- Joseph Spencer Seidel <jsseidel@fastmail.com> Wed, 13 Feb 2019 14:52:20 -0500
5 changes: 5 additions & 0 deletions debian/changelog
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
mktechdocs (1.0.0) bionic; urgency=medium

* Initial Release.

-- Joseph Spencer Seidel <jsseidel@fastmail.com> Wed, 13 Feb 2019 14:52:20 -0500
1 change: 1 addition & 0 deletions debian/compat
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
10
28 changes: 28 additions & 0 deletions debian/control
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Source: mktechdocs
Section: text
Priority: optional
Maintainer: Joseph Spencer Seidel <jsseidel@fastmail.com>
Build-Depends: debhelper (>= 10)
Standards-Version: 4.1.2
Homepage: https://att.github.io/MkTechDocs/

Package: mktechdocs
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, python3-pip, graphviz, plantuml, texlive-xetex, ghostscript, pandoc, gradle, groovy
Description: MkTechDocs is an open framework for collating and transforming markdown.
MkTechDocs is an open framework for collating and transforming markdown. You
can use it to manage complex technical documentation projects with
dependencies, produce light documentation, or combine and transform existing
Markdown files into a styled webpage or PDF document.
+ 100% open source
+ No proprietary, hard-to-read, or hard-to-learn input formats or configuration syntaxes
+ Standardized to Markdown with Pandoc extensions, which is easy to learn and convertible into many other formats
+ Shallow learning curve
+ Builds CSS-styled HTML, PDF, Microsoft Word, and markdown documents from the same source documentation
+ Encourages modular document design
+ Flexible and extensible
+ Projects ideally suited for storing in git repositories, which means documentation work can be distributed like source code
+ Python and Groovy/Java hooks provide easy access to pre-existing code libraries
+ Jinja2 and Groovy template support is baked in for more complex documentation needs Pandodc templates can be customized on a per-project basis
+ Agile and continuous-integration friendly

23 changes: 23 additions & 0 deletions debian/copyright
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: mktechdocs
Source: https://github.com/att/MkTechDocs

Files: debian/*
Copyright: 2019 AT&T Intellectual Property. All rights reserved.
License: Apache-2.0

License: Apache-2.0
Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.

1 change: 1 addition & 0 deletions debian/debhelper-build-stamp
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mktechdocs
2 changes: 2 additions & 0 deletions debian/files
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mktechdocs_1.0.0_amd64.buildinfo text optional
mktechdocs_1.0.0_amd64.deb text optional
1 change: 1 addition & 0 deletions debian/install
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
install_files/opt/* opt
3 changes: 3 additions & 0 deletions debian/mktechdocs-docs.docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
README.source
README
README.Debian
2 changes: 2 additions & 0 deletions debian/mktechdocs.substvars
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
misc:Depends=
misc:Pre-Depends=
6 changes: 6 additions & 0 deletions debian/postinst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/sh

pip3 install pandocfilters
pip3 install jinja2


5 changes: 5 additions & 0 deletions debian/postrm
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/sh

pip3 uninstall pandocfilters
pip3 uninstall jinja2

25 changes: 25 additions & 0 deletions debian/rules
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/usr/bin/make -f
# See debhelper(7) (uncomment to enable)
# output every command that modifies files on the build system.
#export DH_VERBOSE = 1


# see FEATURE AREAS in dpkg-buildflags(1)
#export DEB_BUILD_MAINT_OPTIONS = hardening=+all

# see ENVIRONMENT in dpkg-buildflags(1)
# package maintainers to append CFLAGS
#export DEB_CFLAGS_MAINT_APPEND = -Wall -pedantic
# package maintainers to append LDFLAGS
#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed


%:
dh $@


# dh_make generated override targets
# This is example for Cmake (See https://bugs.debian.org/641051 )
#override_dh_auto_configure:
# dh_auto_configure -- # -DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)

1 change: 1 addition & 0 deletions debian/source/format
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.0 (native)
21 changes: 21 additions & 0 deletions make-deb.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#!/bin/bash

# Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

mkdir -p ./install_files/opt/mktechdocs
cp -r ./bin ./test ./lib ./docs ./install_files/opt/mktechdocs/.

dpkg-buildpackage

0 comments on commit e640387

Please sign in to comment.