Skip to content

Commit c431227

Browse files
stephenfinblp
authored andcommitted
doc: Remove documentation from distdoc target
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]>
1 parent 11e0290 commit c431227

File tree

5 files changed

+9
-62
lines changed

5 files changed

+9
-62
lines changed

Documentation/automake.mk

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
docs += \
2-
Documentation/group-selection-method-property.txt
3-
41
EXTRA_DIST += \
2+
Documentation/group-selection-method-property.txt \
53
Documentation/_static/logo.png \
64
Documentation/conf.py \
75
Documentation/index.rst \
@@ -76,7 +74,7 @@ EXTRA_DIST += \
7674
SPHINXOPTS =
7775
SPHINXBUILD = sphinx-build
7876
SPHINXSRCDIR = $(srcdir)/Documentation
79-
SPHINXBUILDDIR = $(srcdir)/Documentation/_build
77+
SPHINXBUILDDIR = $(builddir)/Documentation/_build
8078

8179
# Internal variables.
8280
PAPEROPT_a4 = -D latex_paper_size=a4

Makefile.am

+2-6
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,11 @@ CLEAN_LOCAL =
6363
DISTCLEANFILES =
6464
PYCOV_CLEAN_FILES = build-aux/check-structs,cover
6565

66-
# A list of Markdown- or reStructuredText-formatted documentation that will
67-
# automatically be included in the "make dist-docs" output.
68-
docs = \
66+
EXTRA_DIST = \
6967
AUTHORS.rst \
7068
CONTRIBUTING.rst \
7169
MAINTAINERS.rst \
72-
README.rst
73-
EXTRA_DIST = \
74-
$(docs) \
70+
README.rst \
7571
NOTICE \
7672
.travis.yml \
7773
.travis/linux-build.sh \

build-aux/dist-docs

+1-49
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ search_path () {
3434
exit 1
3535
}
3636
search_path man
37-
search_path rst2html
3837
search_path ps2pdf
3938

4039
# Create dist-docs directory.
@@ -56,54 +55,7 @@ cat >&3 <<EOF
5655
<link rel="stylesheet" type="text/css" href="style.css">
5756
<title>Open vSwitch $VERSION Documentation</title>
5857
</head><body>
59-
<h1>Open vSwitch $VERSION Documentation</h1>
60-
<h2>Documents</h2>
61-
<table>
62-
EOF
63-
64-
# Add top-level documentation to index.html, giving it .txt extensions so that
65-
# the webserver doesn't serve it as rST and make your web browser try to invoke
66-
# some kind of external helper you don't have installed.
67-
#
68-
# Also translate documentation to HTML.
69-
for file
70-
do
71-
title=`head -1 "$srcdir/$file"`
72-
dir=$distdir/`dirname $file`; test -d "$dir" || mkdir "$dir"
73-
case $file in
74-
*.rst)
75-
title=`grep -A 1 -e "^=" $srcdir/$file | sed -n 2p`
76-
cp "$srcdir/$file" "$distdir/$file.txt"
77-
ln -s $(basename "$file.txt") "$distdir/$file"
78-
rst2html "$distdir/$file.txt" --stylesheet-path="style.css" \
79-
--link-stylesheet --title="$file (Open vSwitch $VERSION)" \
80-
> "$distdir/$file.html"
81-
cat <<EOF
82-
<tr>
83-
<td>$file</td>
84-
<td>$title</td>
85-
<td><a href="$file.html">HTML</a>, <a href="$file.txt">plain text</a></td>
86-
</tr>
87-
EOF
88-
;;
89-
90-
*)
91-
cp "$srcdir/$file" "$distdir/$file"
92-
cat <<EOF
93-
<tr>
94-
<td>$file</td>
95-
<td>$title</td>
96-
<td><a href="$file">plain text</a></td>
97-
</tr>
98-
EOF
99-
;;
100-
esac
101-
done >&3
102-
103-
# Add header for manpages to index.html.
104-
cat >&3 <<EOF
105-
</table>
106-
<h2>Manpages</h2>
58+
<h1>Open vSwitch $VERSION Manpages</h1>
10759
<table>
10860
EOF
10961

debian/rules.modules

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ MA_DIR ?= /usr/share/modass
88
DATAPATH_CONFIGURE_OPTS =
99

1010
kdist_clean:
11-
dh_testdir
11+
dh_testdir
1212
dh_testroot
1313
dh_clean
1414
rm -rf openvswitch

third-party/automake.mk

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
docs += third-party/README.rst
2-
EXTRA_DIST += third-party/ofp-tcpdump.patch
1+
EXTRA_DIST += \
2+
third-party/ofp-tcpdump.patch \
3+
third-party/README.rst

0 commit comments

Comments
 (0)