Skip to content

Commit 10bb6cc

Browse files
vtogvtog
committed
cleanup of build scripts and repo, update to latest f5-sphinx-theme
1 parent 318ee72 commit 10bb6cc

16 files changed

+275
-32
lines changed

‎.gitignore

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
*.sublime-*
1+
docs/_build/*
2+
media/
3+
.DS_Store
24
pdf/*
3-
docs/.vscode/settings.json
4-
python*
5+
.vscode
6+
*.sublime-*

‎buildhtml.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
docker run --rm -it -v %cd%:/data -w /data 0xhiteshpatel/containthedocs:2.3 make -C docs html
1+
docker run --rm -it -v %cd%:/data -w /data f5devcentral/containthedocs:1.0.8 make -C docs html

‎buildpdf.bat

-1
This file was deleted.

‎containthedocs-bash.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ COMMAND="/bin/bash"
66

77
. ./containthedocs-image
88

9-
exec docker run --rm -it \
9+
exec sudo docker run --rm -it \
1010
-v "$PWD":"$PWD" --workdir "$PWD" \
1111
${DOCKER_RUN_ARGS} \
1212
-e "LOCAL_USER_ID=$(id -u)" \

‎containthedocs-build.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ COMMAND="make -C docs html"
66

77
. ./containthedocs-image
88

9-
exec docker run --rm -it \
9+
exec sudo docker run --rm -it \
1010
-v "$PWD":"$PWD" --workdir "$PWD" \
1111
${DOCKER_RUN_ARGS} \
1212
-e "LOCAL_USER_ID=$(id -u)" \

‎containthedocs-image

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
: ${DOC_IMG:=f5devcentral/containthedocs:1.0.4_agility}
1+
: ${DOC_IMG:=f5devcentral/containthedocs:1.0.8}

‎containthedocs-wget

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/usr/bin/env bash
2+
3+
set -x
4+
5+
. ../../containthedocs-image
6+
7+
exec docker run --rm -it \
8+
-v "$PWD":"$PWD" --workdir "$PWD" \
9+
${DOCKER_RUN_ARGS} \
10+
-e "LOCAL_USER_ID=$(id -u)" \
11+
${DOC_IMG} wget -x -nH $1

‎docs/Makefile

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = F5AutomationOrchestration-Introduction
7+
SPHINXPROJ = F5AgilityLabs
88
SOURCEDIR = .
99
BUILDDIR = _build
1010

11-
# Has to be explicit, otherwise we don't get "make" without targets right.
11+
# Put it first so that "make" without argument is like "make help".
1212
help:
1313
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1414

15-
# You can add custom targets here.
15+
.PHONY: help Makefile
1616

1717
# Catch-all target: route all unknown targets to Sphinx using the new
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19-
%:
20-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/_static/css/custom.css

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
img {
2+
margin-bottom: 12px;
3+
}
4+
5+
table {
6+
margin-bottom: 12px;
7+
}
8+
9+
.section ol.loweralpha > li {
10+
list-style: lower-alpha;
11+
padding-bottom: 5px;
12+
}
13+
14+
.section ol.upperalpha > li {
15+
list-style: upper-alpha;
16+
padding-bottom: 5px;
17+
}
18+
19+
.section ol.arabic > li {
20+
list-style: decimal;
21+
padding-bottom: 5px;
22+
}
23+
24+
.section ol.lowerroman > li {
25+
list-style: lower-roman;
26+
padding-bottom: 5px;
27+
}
28+
29+
.section ol.upperroman > li {
30+
list-style: upper-roman;
31+
padding-bottom: 5px;
32+
}
33+
34+
.align-center {
35+
display: block;
36+
margin-left: auto;
37+
margin-right: auto;
38+
}
39+
40+
.align-right {
41+
display: block;
42+
margin-left: auto;
43+
margin-right: 0;
44+
}
45+
46+
.red {
47+
color: rgb(192, 0, 0);
48+
}
49+
50+
.bred {
51+
color: rgb(192, 0, 0);
52+
font-weight: bold;
53+
}
54+
55+
ul {
56+
padding-left: 20px;
57+
padding-top: 5px;
58+
padding-bottom: 5px;
59+
}
60+
61+
ul.simple {
62+
padding-left: 20px;
63+
padding-top: 5px;
64+
padding-bottom: 5px;
65+
}

‎docs/_static/css/f5_agility_theme.css

-13
This file was deleted.

‎docs/_templates/header.html

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<nav class="navbar navbar-default navbar-fixed-top">
2+
<div class="container-fluid">
3+
<div class="row corp-header">
4+
<div class="container corp-header">
5+
<div class="container corp-menu">
6+
<ul>
7+
<li><a href="https://f5.com" class="internalLink">F5.com</a></li>
8+
<li><a href="https://support.f5.com">Support</a></li>
9+
<li><a href="https://devcentral.f5.com">Community</a></li>
10+
<li><a href="https://github.com/F5Networks">GitHub</a></li>
11+
<li><a href="https://f5.com/about-us/careers">Careers</a></li>
12+
</ul>
13+
</div>
14+
</div>
15+
</div>
16+
17+
<div class="row pageHeader">
18+
<div class="container stat">
19+
<div class="col-xs-12 stat">
20+
<a class="internalLink" href="https://f5.com">
21+
<img class="logo" src="https://cdn.f5.com/websites/support/assets/images/logo.svg" width="50" height="44" alt="F5 Networks" title="F5 Networks" border="0">
22+
</a>
23+
<ul id="MainMenu" class="main-menu">
24+
<li>
25+
<a href="#">Products
26+
<span class="indicator"><span class="arrow-up"></span></span>
27+
</a>
28+
29+
<div class="menu-panel soft-hide" id="ProductsSubmenu">
30+
<div class="container">
31+
<ul class="submenu col-sm-11">
32+
<li class="third"><span class="a-mm-h">Connectors</span>
33+
<ul>
34+
<li><a href="http://clouddocs.f5.com/products/connectors/marathon-bigip-ctlr/latest" data-link-type="Nav: Mega">F5 Marathon BIG-IP Controller</a></li>
35+
<li><a href="http://clouddocs.f5.com/products/connectors/marathon-asp-ctlr/latest" data-link-type="Nav: Mega">F5 Marathon ASP Controller</a></li>
36+
<li><a href="http://clouddocs.f5.com/products/connectors/k8s-bigip-ctlr/latest" data-link-type="Nav: Mega">F5 Kubernetes BIG-IP Controller</a></li>
37+
<li><a href="http://clouddocs.f5.com/products/connectors/f5-kube-proxy/latest" data-link-type="Nav: Mega">F5 Kubernetes Proxy</a></li>
38+
</ul>
39+
<!--span class="seemore"><a data-link-type="Nav: Mega" href="/products/connectors">See all </a></--span-->
40+
</li>
41+
<li class="divider"></li>
42+
<li class="third"><span class="a-mm-h">Application Service Proxy</span>
43+
<ul>
44+
<li><a href="http://clouddocs.f5.com/products/asp/latest" data-link-type="Nav: Mega">F5 Application Service Proxy</a></li>
45+
</ul>
46+
<!--span class="seemore"><a href="/products/">See all </a></span-->
47+
</li>
48+
</ul>
49+
</div>
50+
</div>
51+
</li>
52+
<li>
53+
<a href="#">Container Integrations
54+
<span class="indicator"><span class="arrow-up"></span></span>
55+
</a>
56+
57+
<div class="menu-panel soft-hide" id="ContainersSubmenu">
58+
<div class="container">
59+
<ul class="submenu col-sm-11">
60+
<li class="third"><span class="a-mm-h">Container Integrations</span>
61+
<ul>
62+
<li><a href="http://clouddocs.f5.com/containers/latest/marathon/" data-link-type="Nav: Mega">Mesos Marathon</a></li>
63+
<li><a href="http://clouddocs.f5.com/containers/latest/kubernetes/" data-link-type="Nav: Mega">Kubernetes</a></li>
64+
<li><a href="http://clouddocs.f5.com/containers/latest/openshift/" data-link-type="Nav: Mega">RedHat OpenShift</a></li>
65+
</ul>
66+
<span class="seemore"><a data-link-type="Nav: Mega" href="http://clouddocs.f5.com/containers/latest">View details </a></span>
67+
</li>
68+
</ul>
69+
</div>
70+
</div>
71+
</li>
72+
<li>
73+
<a href="#">Clouds
74+
<span class="indicator"><span class="arrow-up"></span></span>
75+
</a>
76+
77+
<div class="menu-panel soft-hide" id="CloudsSubmenu">
78+
<div class="container">
79+
<ul class="submenu col-sm-11">
80+
<li class="third"><span class="a-mm-h">Cloud Integrations</span>
81+
<ul>
82+
<li><a href="http://clouddocs.f5.com/cloud/openstack/" data-link-type="Nav: Mega">OpenStack</a></li>
83+
</ul>
84+
<!--span class="seemore"><a data-link-type="Nav: Mega" href="/cloud/">See all </a></span-->
85+
</li>
86+
</ul>
87+
</div>
88+
</div>
89+
</li>
90+
<li>
91+
<a href="#">Resources
92+
<span class="indicator"><span class="arrow-up"></span></span>
93+
</a>
94+
<div class="menu-panel soft-hide" id="UPCProgramSubmenu">
95+
<div class="container">
96+
<ul class="submenu col-sm-11">
97+
<li class="third">
98+
<span class="a-mm-h">Downloads</span>
99+
<ul>
100+
<li><a target="_blank" data-link-type="Nav: Mega" href="https://hub.docker.com/r/f5networks/" class="internalLink">Docker Hub</a></li>
101+
<li><a target="_blank" data-link-type="Nav: Mega" href="https://store.docker.com/images/f5networks" class="internalLink">Docker Store</a></li>
102+
</ul>
103+
</li>
104+
<li class="divider"></li>
105+
106+
<li class="third">
107+
<span class="a-mm-h">OpenSource</span>
108+
<ul>
109+
<li><a target="_blank" data-link-type="Nav: Mega" href="https://github.com/F5Networks" class="internalLink">GitHub</a></li>
110+
</ul>
111+
</li>
112+
<li class="divider"></li>
113+
114+
<li class="third">
115+
<a href="//university.f5.com" class="a-mm-h internalLink" target="_blank" data-link-type="Nav: Mega">F5 University</a>
116+
<ul>
117+
<li>
118+
<p>Get up to speed with free self-paced courses</p>
119+
</li>
120+
</ul>
121+
<a data-ng-href="https://devcentral.f5.com" class="a-mm-h internalLink" target="_blank" data-link-type="Nav: Mega" href="https://devcentral.f5.com">DevCentral</a>
122+
<ul>
123+
<li>
124+
<p>Join the community of 250,000+ technical peers</p>
125+
</li>
126+
</ul>
127+
</li>
128+
</ul>
129+
</div>
130+
</div>
131+
</li>
132+
</ul>
133+
</div>
134+
</div>
135+
</div>
136+
</div> <!-- /container-fluid -->
137+
</nav>

‎docs/make.bat

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
@ECHO OFF
22

3+
pushd %~dp0
4+
35
REM Command file for Sphinx documentation
46

57
if "%SPHINXBUILD%" == "" (
68
set SPHINXBUILD=sphinx-build
79
)
810
set SOURCEDIR=.
911
set BUILDDIR=_build
10-
set SPHINXPROJ=F5AutomationOrchestration-Introduction
12+
set SPHINXPROJ=F5AgilityLabs
1113

1214
if "%1" == "" goto help
1315

@@ -31,3 +33,4 @@ goto end
3133
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
3234

3335
:end
36+
popd

‎docs/preamble.tex

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
\usepackage{type1cm}
44
\usepackage{helvet}
55
\usepackage{wallpaper}
6+
7+
% Bypass unicode character not supported errors
68
\usepackage[utf8]{inputenc}
79

810
\makeatletter
@@ -13,7 +15,6 @@
1315
#1%
1416
\fi
1517
}
16-
1718
\makeatother
1819

1920
\pagestyle{plain}

‎requirements.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Sphinx==1.6.2
1+
Sphinx<2.0
22
git+git://github.com/f5devcentral/f5-sphinx-theme@master#egg=f5_sphinx_theme
3-
sphinxcontrib-addmetahtml
3+
recommonmark
44
GitPython
5-
#sphinxcontrib-spelling
5+
sphinxcontrib-addmetahtml
66
sphinxcontrib-nwdiag
77
sphinxcontrib-blockdiag
88
sphinxcontrib-seqdiag
9-
sphinxcontrib-actdiag
9+
sphinxcontrib-actdiag

‎scripts/convertdocx.sh

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/usr/bin/env bash
2+
3+
set -x
4+
5+
6+
DOCNAME=${1%.docx}
7+
echo $1
8+
echo $DOCNAME
9+
10+
pandoc -f docx $1 -t rst -o $DOCNAME.rst
11+
mkdir -p tmp media
12+
cd tmp
13+
unzip ../$1
14+
cp -Rf ./word/media/* ../media
15+
cd ..
16+
rm -Rf tmp
17+

‎scripts/server

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/bin/bash
2+
3+
if [ $# -eq 0 ]; then
4+
PORT=8000
5+
else
6+
PORT=$1
7+
fi
8+
9+
if [ -d _build ]; then
10+
echo "Starting server on TCP/$PORT..."
11+
echo "Enter <Ctrl+c> to stop the server..."
12+
cd _build
13+
for i in `cat ../../server-dependencies`
14+
do
15+
../../containthedocs-wget $i;
16+
done
17+
python -mSimpleHTTPServer $PORT
18+
else
19+
echo "The _build directory doesn't exist... try running 'script/setup'"
20+
exit 1
21+
fi

0 commit comments

Comments
 (0)