mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
Code Issues Releases Wiki Activity

doc: Remove documentation from distdoc target

Browse Source 
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 <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
Stephen Finucane 2016-12-08 12:55:30 +00:00 committed by Ben Pfaff
parent 11e029064c
commit c431227e33
5 changed files with 9 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/automake.mk
View File

@ -1,7 +1,5 @@
docs += \
Documentation/group-selection-method-property.txt
EXTRA_DIST += \ EXTRA_DIST += \
Documentation/group-selection-method-property.txt \
Documentation/_static/logo.png \ Documentation/_static/logo.png \
Documentation/conf.py \ Documentation/conf.py \
Documentation/index.rst \ Documentation/index.rst \
@ -76,7 +74,7 @@ EXTRA_DIST += \
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
SPHINXSRCDIR = $(srcdir)/Documentation SPHINXSRCDIR = $(srcdir)/Documentation
SPHINXBUILDDIR = $(srcdir)/Documentation/_build SPHINXBUILDDIR = $(builddir)/Documentation/_build
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4

8
Makefile.am
View File

@ -63,15 +63,11 @@ CLEAN_LOCAL =
DISTCLEANFILES = DISTCLEANFILES =
PYCOV_CLEAN_FILES = build-aux/check-structs,cover PYCOV_CLEAN_FILES = build-aux/check-structs,cover
# A list of Markdown- or reStructuredText-formatted documentation that will EXTRA_DIST = \
# automatically be included in the "make dist-docs" output.
docs = \
AUTHORS.rst \ AUTHORS.rst \
CONTRIBUTING.rst \ CONTRIBUTING.rst \
MAINTAINERS.rst \ MAINTAINERS.rst \
README.rst README.rst \
EXTRA_DIST = \
$(docs) \
NOTICE \ NOTICE \
.travis.yml \ .travis.yml \
.travis/linux-build.sh \ .travis/linux-build.sh \

50
build-aux/dist-docs
View File

@ -34,7 +34,6 @@ search_path () {
exit 1 exit 1
} }
search_path man search_path man
search_path rst2html
search_path ps2pdf search_path ps2pdf
# Create dist-docs directory. # Create dist-docs directory.
@ -56,54 +55,7 @@ cat >&3 <<EOF
<link rel="stylesheet" type="text/css" href="style.css"> <link rel="stylesheet" type="text/css" href="style.css">
<title>Open vSwitch $VERSION Documentation</title> <title>Open vSwitch $VERSION Documentation</title>
</head><body> </head><body>
<h1>Open vSwitch $VERSION Documentation</h1> <h1>Open vSwitch $VERSION Manpages</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>
<table> <table>
EOF EOF

5
third-party/automake.mk vendored
View File

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