aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDave Wallace <dwallacelf@gmail.com>2021-08-12 18:36:02 -0400
committerAndrew Yourtchenko <ayourtch@gmail.com>2021-08-13 15:57:21 +0000
commitd170681b24724c522adaf1e2f4f0e1f3289dbf82 (patch)
tree07b818dde94aa45f2d50da86f5eea5af8659413b /docs
parent078d258034cef5b4ca74d9deb37b2684cc77d060 (diff)
tests docs: upgrade python packages
- Upgrade python package requirements for test & docs - Clean up docs generation warnings - Consolidate python requirements for docs in test requirements specs. - Upgrade pip Type: make Change-Id: I74a3924b43ed93d15b32ec9f6fc41ed1ba95b69b Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py6
-rw-r--r--docs/etc/requirements.txt36
-rw-r--r--docs/gettingstarted/developers/index.rst1
-rwxr-xr-xdocs/scripts/sphinx-make.sh20
4 files changed, 8 insertions, 55 deletions
diff --git a/docs/conf.py b/docs/conf.py
index da8c223f27a..09c4d9b4ce4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -19,8 +19,8 @@
# -- Project information -----------------------------------------------------
project = u'The Vector Packet Processor'
-copyright = u'2018-2020, Linux Foundation'
-author = u'John DeNisco'
+copyright = u'2018-2021, Linux Foundation'
+author = u'FD.io VPP Community'
# The short X.Y version
version = u'master'
@@ -109,7 +109,7 @@ html_static_path = ['_static']
def setup(app):
- app.add_stylesheet('css/rules.css')
+ app.add_css_file('css/rules.css')
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
diff --git a/docs/etc/requirements.txt b/docs/etc/requirements.txt
deleted file mode 100644
index 2df8080ef58..00000000000
--- a/docs/etc/requirements.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-alabaster==0.7.12
-attrs==19.3.0
-Babel==2.8.0
-certifi==2019.11.28
-chardet==3.0.4
-commonmark==0.9.1
-docutils==0.16
-idna==2.9
-imagesize==1.2.0
-importlib-metadata==1.5.0
-Jinja2==2.11.1
-jsonschema==3.2.0
-MarkupSafe==1.1.1
-packaging==20.3
-pyaml==20.3.1
-pyenchant==3.0.1
-Pygments==2.6.1
-pyparsing==2.4.6
-pyrsistent==0.15.7
-pytz==2019.3
-PyYAML==5.3.1
-recommonmark==0.6.0
-requests==2.23.0
-six==1.14.0
-snowballstemmer==2.0.0
-Sphinx==2.4.4
-sphinx-rtd-theme==0.4.3
-sphinxcontrib-applehelp==1.0.2
-sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==1.0.3
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.3
-sphinxcontrib-serializinghtml==1.1.4
-sphinxcontrib-spelling==4.3.0
-urllib3==1.25.8
-zipp==3.1.0
diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
index 9b9a67fcf21..b47abcdf08c 100644
--- a/docs/gettingstarted/developers/index.rst
+++ b/docs/gettingstarted/developers/index.rst
@@ -44,4 +44,5 @@ The Developers section covers the following areas:
quic_plugin
cross_compile_macos.rst
cnat
+ ipsec
VPPAPI.md
diff --git a/docs/scripts/sphinx-make.sh b/docs/scripts/sphinx-make.sh
index b00fb228ca7..e4fb572df97 100755
--- a/docs/scripts/sphinx-make.sh
+++ b/docs/scripts/sphinx-make.sh
@@ -12,30 +12,18 @@ fi
# Get the OS
OS_ID=$(grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
OS_VERSION=$(grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+PIP_VERSION=$(grep 'PIP_VERSION=' $WS_ROOT/test/Makefile | cut -d'=' -f2)
if [ "$1" == "venv" ]
then
- # We need to install the venv package on new systems
- if [ "$OS_ID" == "ubuntu" ]
- then
- sudo apt-get install $CONFIRM python3-venv
- fi
- if [ "$OS_ID" == "centos" ]
- then
- if [ "$OS_VERSION" == "8" ]
- then
- sudo yum install $CONFIRM python3-virtualenv
- else
- sudo yum install $CONFIRM python3-venv
- fi
- fi
# Install the virtual environment
$PYTHON_INTERP -m venv $VENV_DIR
source $VENV_DIR/bin/activate;
- $PYTHON_INTERP -m pip install wheel==0.34.2
- $PYTHON_INTERP -m pip install -r $DOCS_DIR/etc/requirements.txt
+ $PYTHON_INTERP -m pip install pip==$PIP_VERSION
+ $PYTHON_INTERP -m pip install -r $WS_ROOT/test/requirements-3.txt
else
+ [ -n "$(declare -f deactivate)" ] && deactivate
source $VENV_DIR/bin/activate;
VERSION=`source $WS_ROOT/src/scripts/version`
TM=`TZ=GMT date`