From: Quentin Young Date: Wed, 7 Feb 2018 17:33:31 +0000 (-0500) Subject: doc: note appropriate sphinx packages in docs X-Git-Tag: frr-5.0-dev~165^2~38 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=b60f68eaa8f7c843424d48eb36162b96e2bfc9ec;p=mirror%2Ffrr.git doc: note appropriate sphinx packages in docs Signed-off-by: Quentin Young --- diff --git a/doc/developer/Building_FRR_on_CentOS6.rst b/doc/developer/Building_FRR_on_CentOS6.rst index e93ae603ef..7ca14331f0 100644 --- 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 60c4266894..4877c62636 100644 --- 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 cde9df31ad..36ed0c4e66 100644 --- 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 f16cf12dc6..3ba3a90314 100644 --- 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 29c7ee7b0a..ed81d3f59c 100644 --- 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 83e4513636..ccbe8c55c3 100644 --- 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 ccd4596a75..214fdbf9c8 100644 --- 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 b40696a095..909b3a8d64 100644 --- 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 2ddd8bcc44..b9ee9c51e1 100644 --- 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 c4292d7733..ce5c58045f 100644 --- 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 6ce61d3871..eaaf87fd19 100644 --- 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 cd89f14e3c..0eb2b9fec8 100644 --- 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 b9bc19c070..895048886e 100644 --- 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 0ecfbe7365..68e476fec2 100644 --- 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 6fc2f8d79a..10944cb8e1 100644 --- 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 3c6e1ee96f..9c296f8edf 100644 --- 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) ---------------------------------------------