Skip to content

Commit

Permalink
docs: switch developer guide to use sphinx
Browse files Browse the repository at this point in the history
The developer guide now is generated using sphinx
  • Loading branch information
pstorz committed Aug 24, 2018
1 parent ea1610c commit 243155e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
5 changes: 4 additions & 1 deletion docs/debian/rules
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,7 @@
#export DH_VERBOSE=1

%:
dh $@
dh $@

override_dh_auto_clean:

22 changes: 15 additions & 7 deletions docs/manuals/en/developers/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,23 @@ SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = BareosDeveloperGuide
SOURCEDIR = source
BUILDDIR = build
BUILDDIR = .

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
## Put it first so that "make" without argument is like "make help".
#help:
# @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
##
#.PHONY: help clean Makefile

.PHONY: help Makefile

html:
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

packageclean:
rm -Rf $(BUILDDIR)/*

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
#%: Makefile
# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

2 changes: 1 addition & 1 deletion docs/packaging/bareos-docs.dsc
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ Architecture: all
Version: 16.2
Maintainer: Joerg Steffens <joerg.steffens@bareos.com>
Standards-Version: 3.8.4
Build-Depends: bareos-director, bareos-database-sqlite3, bareos-storage, bareos-filedaemon, bareos-bconsole, bareos-traymonitor, debhelper, dvipng, ghostscript, graphviz, imagemagick, librsvg2-bin, pandoc, python, texlive-fonts-recommended, texlive-latex-extra, tex4ht
Build-Depends: bareos-director, bareos-database-sqlite3, bareos-storage, bareos-filedaemon, bareos-bconsole, bareos-traymonitor, debhelper, dvipng, ghostscript, graphviz, imagemagick, librsvg2-bin, pandoc, python, texlive-fonts-recommended, texlive-latex-extra, tex4ht, python-sphinx, python-sphinx-rtd-theme
DEBTRANSFORM-RELEASE: unstable; urgency=low

0 comments on commit 243155e

Please sign in to comment.