doc: note appropriate sphinx packages in docs

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>

diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst
index e93ae603ef33b02856c3aab99257170941b6ffef..7ca14331f03b400185222d924245947e3d90422d 100644 (file)
--- a/doc/developer/Building_FRR_on_CentOS6.rst
+++ b/doc/developer/Building_FRR_on_CentOS6.rst
@@ -31,7 +31,7 @@ Add packages:
     sudo yum install git autoconf automake libtool make gawk \
       readline-devel texinfo net-snmp-devel groff pkgconfig \
       json-c-devel pam-devel flex epel-release perl-XML-LibXML \
-      c-ares-devel
+      c-ares-devel python-sphinx
 
 Install newer version of bison (CentOS 6 package source is too old) from
 CentOS 7

diff --git a/doc/developer/Building_FRR_on_CentOS7.rst b/doc/developer/Building_FRR_on_CentOS7.rst
index 60c42668949f1f7cc1e7fb1c073c1c695e78b242..4877c62636b1c630544631c75179c2de4ed16fab 100644 (file)
--- a/doc/developer/Building_FRR_on_CentOS7.rst
+++ b/doc/developer/Building_FRR_on_CentOS7.rst
@@ -22,7 +22,7 @@ Add packages:
     sudo yum install git autoconf automake libtool make gawk \
       readline-devel texinfo net-snmp-devel groff pkgconfig \
       json-c-devel pam-devel bison flex pytest c-ares-devel \
-      perl-XML-LibXML python-devel
+      perl-XML-LibXML python-devel python-sphinx
 
 Get FRR, compile it and install it (from Git)
 ---------------------------------------------

diff --git a/doc/developer/Building_FRR_on_Debian8.rst b/doc/developer/Building_FRR_on_Debian8.rst
index cde9df31adf71db6374d75cb61afb77ccc0b4d0b..36ed0c4e6621f57452a1f654439498e0293d1b03 100644 (file)
--- a/doc/developer/Building_FRR_on_Debian8.rst
+++ b/doc/developer/Building_FRR_on_Debian8.rst
@@ -17,7 +17,7 @@ Add packages:
 
     sudo apt-get install git autoconf automake libtool make gawk \
        libreadline-dev texinfo libjson-c-dev pkg-config bison flex \
-       python-pip libc-ares-dev python3-dev
+       python-pip libc-ares-dev python3-dev python3-sphinx
 
 Install newer pytest (>3.0) from pip
 

diff --git a/doc/developer/Building_FRR_on_Debian9.rst b/doc/developer/Building_FRR_on_Debian9.rst
index f16cf12dc6a26b101b6ec43170bd9d8f87232eb5..3ba3a90314eae8e830097c0496557e25cf6f2333 100644 (file)
--- a/doc/developer/Building_FRR_on_Debian9.rst
+++ b/doc/developer/Building_FRR_on_Debian9.rst
@@ -10,7 +10,7 @@ Add packages:
 
     sudo apt-get install git autoconf automake libtool make \
       libreadline-dev texinfo libjson-c-dev pkg-config bison flex \
-      python-pip libc-ares-dev python3-dev python-pytest
+      python-pip libc-ares-dev python3-dev python-pytest python3-sphinx
 
 Get FRR, compile it and install it (from Git)
 ---------------------------------------------

diff --git a/doc/developer/Building_FRR_on_Fedora24.rst b/doc/developer/Building_FRR_on_Fedora24.rst
index 29c7ee7b0a958dedf0f2191c644ae5ec10e6e10e..ed81d3f59c40802cd15c7426f2c2f1af22cdbac0 100644 (file)
--- a/doc/developer/Building_FRR_on_Fedora24.rst
+++ b/doc/developer/Building_FRR_on_Fedora24.rst
@@ -15,7 +15,7 @@ Add packages:
     sudo dnf install git autoconf automake libtool make gawk \
       readline-devel texinfo net-snmp-devel groff pkgconfig \
       json-c-devel pam-devel perl-XML-LibXML pytest bison flex \
-      c-ares-devel python3-devel
+      c-ares-devel python3-devel python3-sphinx
 
 Get FRR, compile it and install it (from Git)
 ---------------------------------------------

diff --git a/doc/developer/Building_FRR_on_FreeBSD10.rst b/doc/developer/Building_FRR_on_FreeBSD10.rst
index 83e45136369e6014919cc7326afc8fe31e514b48..ccbe8c55c331e5e013af2f72008b6e1936215697 100644 (file)
--- a/doc/developer/Building_FRR_on_FreeBSD10.rst
+++ b/doc/developer/Building_FRR_on_FreeBSD10.rst
@@ -17,7 +17,7 @@ is first package install and asked)
 ::
 
     pkg install git autoconf automake libtool gmake gawk json-c pkgconf \
-        bison flex py27-pytest c-ares python3
+        bison flex py27-pytest c-ares python3 py-sphinx
 
 Make sure there is no /usr/bin/flex preinstalled (and use the newly
 installed in /usr/local/bin): (FreeBSD frequently provides a older flex

diff --git a/doc/developer/Building_FRR_on_FreeBSD11.rst b/doc/developer/Building_FRR_on_FreeBSD11.rst
index ccd4596a75d491cdfd92293e48c061cf02a38877..214fdbf9c8464c2effcae3669a4f78192cd1232c 100644 (file)
--- a/doc/developer/Building_FRR_on_FreeBSD11.rst
+++ b/doc/developer/Building_FRR_on_FreeBSD11.rst
@@ -17,7 +17,7 @@ is first package install and asked)
 ::
 
     pkg install git autoconf automake libtool gmake gawk json-c pkgconf \
-        bison flex py27-pytest c-ares python3
+        bison flex py27-pytest c-ares python3 py-sphinx
 
 Make sure there is no /usr/bin/flex preinstalled (and use the newly
 installed in /usr/local/bin): (FreeBSD frequently provides a older flex

diff --git a/doc/developer/Building_FRR_on_FreeBSD9.rst b/doc/developer/Building_FRR_on_FreeBSD9.rst
index b40696a0958388b4086df38de81030a499b30bfa..909b3a8d64562509eddb5992629ed27113bbc484 100644 (file)
--- a/doc/developer/Building_FRR_on_FreeBSD9.rst
+++ b/doc/developer/Building_FRR_on_FreeBSD9.rst
@@ -18,7 +18,7 @@ is first package install and asked)
 
     pkg install -y git autoconf automake libtool gmake gawk \
         pkgconf texinfo json-c bison flex py27-pytest c-ares \
-        python3
+        python3 py-sphinx
 
 Make sure there is no /usr/bin/flex preinstalled (and use the newly
 installed in /usr/local/bin): (FreeBSD frequently provides a older flex

diff --git a/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst b/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst
index 2ddd8bcc44ab0afacd15e6f65ea0cd25ac31df7d..b9ee9c51e139ac7b68fdebab92f3b617672bb7e4 100644 (file)
--- a/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst
+++ b/doc/developer/Building_FRR_on_LEDE-OpenWRT.rst
@@ -19,28 +19,28 @@ Ubuntu 12.04LTS:
 
     sudo apt-get install build-essential subversion git-core \
        libncurses5-dev zlib1g-dev gawk flex quilt libssl-dev xsltproc \
-       libxml-parser-perl mercurial bzr ecj cvs unzip
+       libxml-parser-perl mercurial bzr ecj cvs unzip python3-sphinx
 
 Ubuntu 64bit:
 
 ::
 
     sudo apt-get install build-essential subversion libncurses5-dev zlib1g-dev \
-       gawk gcc-multilib flex git-core gettext libssl-dev
+       gawk gcc-multilib flex git-core gettext libssl-dev python3-sphinx
 
 Debian 8 Jessie:
 
 ::
 
     sudo apt-get install build-essential libncurses5-dev gawk git subversion \
-       libssl-dev gettext unzip zlib1g-dev file python
+       libssl-dev gettext unzip zlib1g-dev file python python3-sphinx
 
 Debian 9 Stretch:
 
 ::
 
     sudo apt-get install build-essential libncurses5-dev gawk git subversion \
-       libssl-dev gettext zlib1g-dev
+       libssl-dev gettext zlib1g-dev python3-sphinx
 
 Centos x86-64 (some packages require EPEL):
 
@@ -49,7 +49,7 @@ Centos x86-64 (some packages require EPEL):
     yum install subversion binutils bzip2 gcc gcc-c++ gawk gettext flex \
        ncurses-devel zlib-devel zlib-static make patch unzip glibc glibc-devel \
        perl-ExtUtils-MakeMaker glibc-static quilt ncurses-libs sed sdcc bison \
-       intltool sharutils wget git-core openssl-devel xz
+       intltool sharutils wget git-core openssl-devel xz python-sphinx
 
 Fedora 24 - 64Bit:
 
@@ -58,7 +58,8 @@ Fedora 24 - 64Bit:
     dnf install -y subversion binutils bzip2 gcc gcc-c++ gawk gettext git-core \
        unzip ncurses-devel ncurses-compat-libs zlib-devel zlib-static make \
        flex patch perl-ExtUtils-MakeMaker perl-Thread-Queue glibc glibc-devel \
-       glibc-static quilt sed sdcc intltool sharutils bison wget openssl-devel
+       glibc-static quilt sed sdcc intltool sharutils bison wget openssl-devel \
+       python3-sphinx
 
 Get LEDE Sources (from Git)
 ---------------------------

diff --git a/doc/developer/Building_FRR_on_NetBSD6.rst b/doc/developer/Building_FRR_on_NetBSD6.rst
index c4292d7733b11ae6a82d191d0cd1f9a239cb9f7e..ce5c58045f10a98a217fa58fba6ce553a7fab4b9 100644 (file)
--- a/doc/developer/Building_FRR_on_NetBSD6.rst
+++ b/doc/developer/Building_FRR_on_NetBSD6.rst
@@ -23,7 +23,7 @@ Add packages:
 ::
 
     sudo pkg_add git autoconf automake libtool gmake gawk openssl \
-       pkg-config json-c python27 py27-test python35
+       pkg-config json-c python27 py27-test python35 py-sphinx
 
 Install SSL Root Certificates (for git https access):
 

diff --git a/doc/developer/Building_FRR_on_NetBSD7.rst b/doc/developer/Building_FRR_on_NetBSD7.rst
index 6ce61d3871a7e78d68411a6c07848e7c189cdbf7..eaaf87fd1909e26decaebe64b97afbe9f415e984 100644 (file)
--- a/doc/developer/Building_FRR_on_NetBSD7.rst
+++ b/doc/developer/Building_FRR_on_NetBSD7.rst
@@ -14,7 +14,7 @@ Install required packages
 ::
 
     sudo pkgin install git autoconf automake libtool gmake gawk openssl \
-       pkg-config json-c python27 py27-test python35
+       pkg-config json-c python27 py27-test python35 py-sphinx
 
 Install SSL Root Certificates (for git https access):
 

diff --git a/doc/developer/Building_FRR_on_OmniOS.rst b/doc/developer/Building_FRR_on_OmniOS.rst
index cd89f14e3c6bc5cabff644a6a165d0a8bcb76150..0eb2b9fec8f865e797e24cb6f796e3236f04efd6 100644 (file)
--- a/doc/developer/Building_FRR_on_OmniOS.rst
+++ b/doc/developer/Building_FRR_on_OmniOS.rst
@@ -62,6 +62,10 @@ Add pytest:
 
     pip install pytest
 
+Install Sphinx:::
+
+   pip install sphinx
+
 Select Python 2.7 as default (required for pytest)
 
 ::

diff --git a/doc/developer/Building_FRR_on_OpenBSD6.rst b/doc/developer/Building_FRR_on_OpenBSD6.rst
index b9bc19c0704f7940bc119a174e4d3e7f31308a07..895048886e8f50ec334e2019b9bc6ed2f97d438b 100644 (file)
--- a/doc/developer/Building_FRR_on_OpenBSD6.rst
+++ b/doc/developer/Building_FRR_on_OpenBSD6.rst
@@ -15,7 +15,7 @@ Add packages:
 ::
 
     pkg_add git autoconf-2.69p2 automake-1.15p0 libtool bison
-    pkg_add gmake gawk dejagnu openssl json-c py-test
+    pkg_add gmake gawk dejagnu openssl json-c py-test py-sphinx
 
 Select Python2.7 as default (required for pytest)
 

diff --git a/doc/developer/Building_FRR_on_Ubuntu1204.rst b/doc/developer/Building_FRR_on_Ubuntu1204.rst
index 0ecfbe7365dbddc6d7ca38ba454a5e887d7048d7..68e476fec29febf14e7b2d25783bf1acad5c5b23 100644 (file)
--- a/doc/developer/Building_FRR_on_Ubuntu1204.rst
+++ b/doc/developer/Building_FRR_on_Ubuntu1204.rst
@@ -15,7 +15,7 @@ Add packages:
 
     apt-get install git autoconf automake libtool make gawk libreadline-dev \
        texinfo libpam0g-dev dejagnu libjson0-dev pkg-config libpam0g-dev \
-       libjson0-dev flex python-pip libc-ares-dev python3-dev
+       libjson0-dev flex python-pip libc-ares-dev python3-dev python3-sphinx
 
 Install newer bison from 14.04 package source (Ubuntu 12.04 package
 source is too old)

diff --git a/doc/developer/Building_FRR_on_Ubuntu1404.rst b/doc/developer/Building_FRR_on_Ubuntu1404.rst
index 6fc2f8d79a550243080d96c445e6f7e4aaaea736..10944cb8e183283f0072a8603a778ecf5781bacf 100644 (file)
--- a/doc/developer/Building_FRR_on_Ubuntu1404.rst
+++ b/doc/developer/Building_FRR_on_Ubuntu1404.rst
@@ -15,7 +15,7 @@ Add packages:
 
     apt-get install git autoconf automake libtool make gawk libreadline-dev \
        texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \
-       python-pytest libc-ares-dev python3-dev
+       python-pytest libc-ares-dev python3-dev python3-sphinx
 
 Get FRR, compile it and install it (from Git)
 ---------------------------------------------

diff --git a/doc/developer/Building_FRR_on_Ubuntu1604.rst b/doc/developer/Building_FRR_on_Ubuntu1604.rst
index 3c6e1ee96f6dc5a0f17d1e69b3f902b5d64bca4f..9c296f8edf6aaa856cb7a64479651adc65183ed3 100644 (file)
--- a/doc/developer/Building_FRR_on_Ubuntu1604.rst
+++ b/doc/developer/Building_FRR_on_Ubuntu1604.rst
@@ -15,7 +15,8 @@ Add packages:
 
     apt-get install git autoconf automake libtool make gawk libreadline-dev \
        texinfo dejagnu pkg-config libpam0g-dev libjson-c-dev bison flex \
-       python-pytest libc-ares-dev python3-dev libsystemd-dev python-ipaddr
+       python-pytest libc-ares-dev python3-dev libsystemd-dev python-ipaddr \
+       python3-sphinx
 
 Get FRR, compile it and install it (from Git)
 ---------------------------------------------