[master 4/5] Add a helper for building Sphinx docs using mock.

bcl installerbot-noreply at redhat.com
Fri Jul 10 17:51:30 UTC 2015


From: "Brian C. Lane" <bcl at redhat.com>

Run ./scripts/make-sphinx-docs and after a while you will have new html
docs in ./docs/html.new/ and instructions on how to update the gh-pages.

This needs to be run from a host with a GUI, otherwise you get Gtk
errors and a coredump from sphinx trying to import the project inside
the mock chroot.
---
 scripts/make-sphinx-docs | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100755 scripts/make-sphinx-docs

diff --git a/scripts/make-sphinx-docs b/scripts/make-sphinx-docs
new file mode 100755
index 0000000..3fbcd7b
--- /dev/null
+++ b/scripts/make-sphinx-docs
@@ -0,0 +1,38 @@
+#!/bin/bash
+#
+# Helper script for updating the Sphinx documentation. It requires a full install of the
+# dependencies so we do that in a mock chroot.
+#
+# Copyright (C) 2015  Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation; either version 2.1 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Brian C. Lane <bcl at redhat.com>
+#
+MOCKCFG=fedora-rawhide-x86_64
+
+if [ -z "$DISPLAY" ]; then
+    echo "Run script on a desktop system with a GUI"
+    exit 1
+fi
+mock -r $MOCKCFG --init
+mock -r $MOCKCFG -i anaconda-gui -i python3-sphinx -i python3-sphinx_rtd_theme -i ostree
+mock -r $MOCKCFG --copyin $PWD /builddir/anaconda/
+# Note that DISPLAY is needed to make GTK happy, so this needs to be run from a system with a GUI
+mock -r $MOCKCFG --chroot "cd /builddir/anaconda/docs/; DISPLAY=$DISPLAY make -f Makefile.am html"
+mock -r $MOCKCFG --copyout /builddir/anaconda/docs/html $PWD/docs/html.new
+
+echo "Now make sure the ./docs/html.new/ looks ok and copy it over the top of ./docs/html/ and commit."
+echo "Then copy ./docs/html/ outside the repo and check out the gh-pages branch. Copy them back to /"
+echo "and commit to update the https://rhinstaller.github.io/anaconda/ page."


-- 
To view this commit on github, visit https://github.com/rhinstaller/anaconda/commit/400d42f0136d824a8e8f65d511af2106d1592531


More information about the anaconda-patches mailing list