docs: Update the requirements and fix the build

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I30e37f7e549083337b11ace95b4ff4f427d9fc8c
This commit is contained in:
John DeNisco 2020-01-24 14:04:41 -05:00
parent d539e256b2
commit a273ce62d7
4 changed files with 37 additions and 35 deletions

View File

@ -40,8 +40,10 @@ release = u'20.01'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'recommonmark',
'sphinxcontrib.spelling']
'recommonmark']
# This is currently breaking the build
#### 'sphinxcontrib.spelling']
spelling_word_list_filename = 'spelling_wordlist.txt'
# Add any paths that contain templates here, relative to this directory.

View File

@ -1,25 +1,22 @@
alabaster==0.7.12
Babel==2.6.0
certifi==2019.3.9
Babel==2.8.0
certifi==2019.11.28
chardet==3.0.4
commonmark==0.9.0
docutils==0.14
future==0.17.1
commonmark==0.9.1
docutils==0.16
idna==2.8
imagesize==1.1.0
Jinja2==2.10.1
Markdown==2.6.11
imagesize==1.2.0
Jinja2==2.10.3
MarkupSafe==1.1.1
packaging==19.0
Pygments==2.4.0
pyparsing==2.4.0
pytz==2019.1
recommonmark==0.5.0
requests==2.21.0
six==1.12.0
snowballstemmer==1.2.1
Sphinx==2.0.1
sphinx-markdown-tables==0.0.9
packaging==20.0
Pygments==2.5.2
pyparsing==2.4.6
pytz==2019.3
recommonmark==0.6.0
requests==2.22.0
six==1.14.0
snowballstemmer==2.0.0
Sphinx==2.3.1
sphinx-rtd-theme==0.4.3
sphinxcontrib-applehelp==1.0.1
sphinxcontrib-devhelp==1.0.1
@ -27,5 +24,4 @@ sphinxcontrib-htmlhelp==1.0.2
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
sphinxcontrib-spelling==4.3.0
urllib3==1.24.3
urllib3==1.25.8

View File

@ -29,6 +29,7 @@ SITE_USERNAME=$1
VPP_BRANCH=$2
#Build the docs
make docs-clean
make docs-venv
make docs
@ -46,27 +47,30 @@ git merge -m "Publish the Docs" upstream/master
VERSION=`source $WS_ROOT/src/scripts/version`
VERSION=${VERSION/"~"/"-"}
# Create a branch for the commit
git checkout -b $VERSION
git branch
# Copy the files to the appropriate directory
SRC_DIR=../docs/_build/html/.
if [ "$VPP_BRANCH" == "master" ]
then
TARGET_DIR=./static/docs/vpp/master
rm -fr ./static/docs/vpp/master
rm -fr $TARGET_DIR
else
TARGET_DIR=./static/docs/vpp/v$VPP_BRANCH
rm -fr ./static/docs/vpp/$TARGET_DIR
mkdir -p ./static/docs/vpp/$TARGET_DIR
rm -fr $TARGET_DIR
mkdir -p $TARGET_DIR
VERSION=v$VPP_BRANCH
ln -s $VERSION ./static/docs/vpp/latest
fi
# Create a branch for the commit
git checkout -b $VERSION
git branch
# Copy the docs
cp -r $SRC_DIR $TARGET_DIR
# Push the new docs
git add "*"
git commit -s -m "Publish docs from VPP $VERSION"
git push origin "$VERSION"
#git add "*"
#git commit -s -m "Publish docs from VPP $VERSION"
#git push origin "$VERSION"
exit 0

View File

@ -1,15 +1,15 @@
.. _sanitizer:
**************
*****************
Google Sanitizers
**************
*****************
VPP is instrumented to support `Google Sanitizers <https://github.com/google/sanitizers>`_.
As of today, only `AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_
is supported and only for the heap.
AddressSanitizer
==============
================
`AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (aka ASan) is a memory
error detector for C/C++. Think Valgrind but much faster.