Skip to content

Commit b65f0b8

Browse files
dseevrdseevr
committed
Contiv nav header is now automatically added to API documentation when generated
Signed-off-by: Bill Robinson <[email protected]>
1 parent 5f39b12 commit b65f0b8

7 files changed

+97
-28
lines changed

‎scripts/build.sh

+6-7
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,17 @@ mkdir -p docs
2121
mv contiv.html docs/
2222
popd
2323

24-
# RAML doesn't currently support trailing slashes so we add them manually here
25-
26-
# altering the HTML requires a gem called Nokogiri
27-
# create a tiny docker image so we don't have to reinstall Nokogiri every time
28-
IMAGE_NAME="raml_trailing_slashes"
24+
# because we have to do some tidying up of the output HTML and it requires some
25+
# external dependencies, we use a small Docker image to do it.
26+
# this image uses the same ruby:2.4.0-slim base as above.
27+
IMAGE_NAME="contiv_api_documentation_cleanup"
2928

3029
if [[ "$(docker images -q $IMAGE_NAME:latest 2>/dev/null)" == "" ]]; then
31-
docker build -t $IMAGE_NAME -f spec/Dockerfile.raml_trailing_slashes .
30+
docker build -t $IMAGE_NAME -f spec/Dockerfile.cleanup .
3231
fi
3332

3433
docker run --rm \
3534
-u $(id -u):$(id -g) \
3635
-v $(pwd):/files \
3736
-w /files/spec \
38-
$IMAGE_NAME /usr/local/bin/ruby raml_trailing_slashes.rb
37+
$IMAGE_NAME /usr/local/bin/ruby cleanup.rb

‎spec/Dockerfile.raml_trailing_slashes ‎spec/Dockerfile.cleanup

File renamed without changes.

‎spec/cleanup.rb

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#!/usr/bin/env ruby
2+
# encoding: utf-8
3+
4+
require "nokogiri"
5+
6+
FILENAME = "docs/contiv.html"
7+
8+
doc = Nokogiri::HTML(File.read(FILENAME))
9+
10+
# add trailing slashes to all paths
11+
12+
node_groups = [
13+
doc.css(".panel-title a").select { |n| n.text.start_with?("/") },
14+
doc.css(".modal-title"),
15+
]
16+
17+
node_groups.flatten.each do |node|
18+
node.children.last.content = node.children.last.text + "/"
19+
end
20+
21+
# insert additional <head> tag requirements for the contiv header
22+
23+
doc.at("head") << Nokogiri::HTML::DocumentFragment.parse(File.read("docs/head.html"))
24+
25+
# insert the contiv header html into the top of the <body>
26+
27+
doc.at("body").prepend_child(Nokogiri::HTML::DocumentFragment.parse(File.read("docs/body.html")))
28+
29+
# overwrite the original HTML file
30+
31+
File.write(FILENAME, doc.to_html)

‎spec/docs/body.html

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<div class="navbar-jumbotron">
2+
<nav class="navbar navbar-inverse navbar-static-top" role="navigation">
3+
<div class="container">
4+
<div class="navbar-header">
5+
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
6+
<span class="sr-only">Toggle navigation</span>
7+
<span class="icon-bar"></span>
8+
<span class="icon-bar"></span>
9+
<span class="icon-bar"></span>
10+
</button>
11+
<a class="navbar-brand" href="/" style="color:$white"> Contiv </a>
12+
</div>
13+
<div class="collapse navbar-collapse" id="navbar">
14+
<ul class="nav navbar-nav navbar-right main-nav">
15+
<li><a href="/documents/">Docs</a></li>
16+
<li><a href="https://github.com/contiv/install/releases">Download</a></li>
17+
<li><a href="/documents/support/index.html">Support</a></li>
18+
<li><a href="http://blogs.cisco.com/contiv">Blog</a></li>
19+
20+
<li><a href="https://github.com/contiv"target="_blank"><i class="fa fa-github" style="color:$white"></i></a></li>
21+
<li><a href="https://contiv.herokuapp.com" target="_blank"><i class="fa fa-slack"style="color:$white"></i></a></li>
22+
</ul>
23+
</div>
24+
</div>
25+
</nav>
26+
</div>

‎spec/docs/contiv.html

+32-2
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,37 @@
176176
margin-bottom: 1em;
177177
}
178178
</style>
179+
<link rel="shortcut icon" href="/assets/images/favicon.png">
180+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
179181
</head>
180-
<body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row">
182+
<body data-spy="scroll" data-target="#sidebar">
183+
<div class="navbar-jumbotron">
184+
<nav class="navbar navbar-inverse navbar-static-top" role="navigation">
185+
<div class="container">
186+
<div class="navbar-header">
187+
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
188+
<span class="sr-only">Toggle navigation</span>
189+
<span class="icon-bar"></span>
190+
<span class="icon-bar"></span>
191+
<span class="icon-bar"></span>
192+
</button>
193+
<a class="navbar-brand" href="/" style="color:$white"> Contiv </a>
194+
</div>
195+
<div class="collapse navbar-collapse" id="navbar">
196+
<ul class="nav navbar-nav navbar-right main-nav">
197+
<li><a href="/documents/">Docs</a></li>
198+
<li><a href="https://github.com/contiv/install/releases">Download</a></li>
199+
<li><a href="/documents/support/index.html">Support</a></li>
200+
<li><a href="http://blogs.cisco.com/contiv">Blog</a></li>
201+
202+
<li><a href="https://github.com/contiv" target="_blank"><i class="fa fa-github" style="color:$white"></i></a></li>
203+
<li><a href="https://contiv.herokuapp.com" target="_blank"><i class="fa fa-slack" style="color:$white"></i></a></li>
204+
</ul>
205+
</div>
206+
</div>
207+
</nav>
208+
</div>
209+
<div class="container"><div class="row">
181210
<div class="col-md-9" role="main">
182211
<div class="page-header">
183212
<h1>Contiv API documentation <small>version v1</small>
@@ -9774,5 +9803,6 @@ <h3>Headers</h3>
97749803
<li><a href="#servicelbs">Service Load Balancers</a></li>
97759804
<li><a href="#tenants">Tenants</a></li>
97769805
</ul></div></div>
9777-
</div></div></body>
9806+
</div></div>
9807+
</body>
97789808
</html>

‎spec/docs/head.html

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<link rel="shortcut icon" href="/assets/images/favicon.png">
2+
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">

‎spec/raml_trailing_slashes.rb

-19
This file was deleted.

0 commit comments

Comments
 (0)