Skip to content

Commit

Permalink
doc: Remove documentation from distdoc target
Browse files Browse the repository at this point in the history
Basic Sphinx integration is now complete. Remove the documentation
aspects of the 'dist-docs' target in favor of the htmldocs target.

Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Ben Pfaff <[email protected]>
  • Loading branch information
stephenfin authored and blp committed Dec 12, 2016
1 parent 11e0290 commit c431227
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 62 deletions.
6 changes: 2 additions & 4 deletions Documentation/automake.mk
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
docs += \
Documentation/group-selection-method-property.txt

EXTRA_DIST += \
Documentation/group-selection-method-property.txt \
Documentation/_static/logo.png \
Documentation/conf.py \
Documentation/index.rst \
Expand Down Expand Up @@ -76,7 +74,7 @@ EXTRA_DIST += \
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXSRCDIR = $(srcdir)/Documentation
SPHINXBUILDDIR = $(srcdir)/Documentation/_build
SPHINXBUILDDIR = $(builddir)/Documentation/_build

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
Expand Down
8 changes: 2 additions & 6 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,11 @@ CLEAN_LOCAL =
DISTCLEANFILES =
PYCOV_CLEAN_FILES = build-aux/check-structs,cover

# A list of Markdown- or reStructuredText-formatted documentation that will
# automatically be included in the "make dist-docs" output.
docs = \
EXTRA_DIST = \
AUTHORS.rst \
CONTRIBUTING.rst \
MAINTAINERS.rst \
README.rst
EXTRA_DIST = \
$(docs) \
README.rst \
NOTICE \
.travis.yml \
.travis/linux-build.sh \
Expand Down
50 changes: 1 addition & 49 deletions build-aux/dist-docs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ search_path () {
exit 1
}
search_path man
search_path rst2html
search_path ps2pdf

# Create dist-docs directory.
Expand All @@ -56,54 +55,7 @@ cat >&3 <<EOF
<link rel="stylesheet" type="text/css" href="style.css">
<title>Open vSwitch $VERSION Documentation</title>
</head><body>
<h1>Open vSwitch $VERSION Documentation</h1>
<h2>Documents</h2>
<table>
EOF

# Add top-level documentation to index.html, giving it .txt extensions so that
# the webserver doesn't serve it as rST and make your web browser try to invoke
# some kind of external helper you don't have installed.
#
# Also translate documentation to HTML.
for file
do
title=`head -1 "$srcdir/$file"`
dir=$distdir/`dirname $file`; test -d "$dir" || mkdir "$dir"
case $file in
*.rst)
title=`grep -A 1 -e "^=" $srcdir/$file | sed -n 2p`
cp "$srcdir/$file" "$distdir/$file.txt"
ln -s $(basename "$file.txt") "$distdir/$file"
rst2html "$distdir/$file.txt" --stylesheet-path="style.css" \
--link-stylesheet --title="$file (Open vSwitch $VERSION)" \
> "$distdir/$file.html"
cat <<EOF
<tr>
<td>$file</td>
<td>$title</td>
<td><a href="$file.html">HTML</a>, <a href="$file.txt">plain text</a></td>
</tr>
EOF
;;

*)
cp "$srcdir/$file" "$distdir/$file"
cat <<EOF
<tr>
<td>$file</td>
<td>$title</td>
<td><a href="$file">plain text</a></td>
</tr>
EOF
;;
esac
done >&3

# Add header for manpages to index.html.
cat >&3 <<EOF
</table>
<h2>Manpages</h2>
<h1>Open vSwitch $VERSION Manpages</h1>
<table>
EOF

Expand Down
2 changes: 1 addition & 1 deletion debian/rules.modules
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ MA_DIR ?= /usr/share/modass
DATAPATH_CONFIGURE_OPTS =

kdist_clean:
dh_testdir
dh_testdir
dh_testroot
dh_clean
rm -rf openvswitch
Expand Down
5 changes: 3 additions & 2 deletions third-party/automake.mk
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
docs += third-party/README.rst
EXTRA_DIST += third-party/ofp-tcpdump.patch
EXTRA_DIST += \
third-party/ofp-tcpdump.patch \
third-party/README.rst

0 comments on commit c431227

Please sign in to comment.