Revise docs

Add version number
nasa · Sep 28, 2020 · b43e8bd · b43e8bd
1 parent 51a7890
commit b43e8bd
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 19 deletions.
diff --git a/README.adoc b/README.adoc
@@ -6,7 +6,7 @@ https://github.jpl.nasa.gov/FPRIME/fprime-sw[F Prime flight software framework].
 
 == Contents
 
-`docs`: The FPP specification and user's guide.
+`docs`: The FPP Specification and User's Guide.
 
 `editors`: Syntax highlighting for code editors. Currently vim is supported.
 

diff --git a/defs.sh b/defs.sh
@@ -2,6 +2,8 @@
 # defs.sh: definitions common to all subdirectories
 # ----------------------------------------------------------------------
 
+export VERSION=v0.1.0
+
 # Users of this file should set LEVEL first
 if test -z "$LEVEL"; then
   export LEVEL=.
@@ -40,12 +42,3 @@ rm_tmp()
   doall rm '*~'
   doall rm '*redo*tmp'
 }
-
-# Exclude dot where it can cause problems
-nodot()
-{
-  if echo "$2" | grep -q '\.'; then
-    echoerr 'no rule to make '"$2"
-    return 1
-  fi
-}
diff --git a/docs/fpp-users-guide.html b/docs/fpp-users-guide.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.10">
-<title>The F Prime Prime (FPP) User&#8217;s Guide</title>
+<title>The F Prime Prime (FPP) User&#8217;s Guide, v0.1.0</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -438,7 +438,7 @@
 </head>
 <body class="article toc2 toc-left">
 <div id="header">
-<h1>The F Prime Prime (FPP) User&#8217;s Guide</h1>
+<h1>The F Prime Prime (FPP) User&#8217;s Guide, v0.1.0</h1>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
@@ -4445,7 +4445,7 @@ <h3 id="Analyzing-and-Translating-Models_Translating-XML-to-FPP">9.5. Translatin
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2020-09-22 16:45:11 -0700
+Last updated 2020-09-28 11:35:43 -0700
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">

diff --git a/docs/index.html b/docs/index.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 2.0.10">
-<title>The F Prime Prime (FPP) Language Specification</title>
+<title>The F Prime Prime (FPP) Language Specification, v0.1.0</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /* Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
@@ -438,7 +438,7 @@
 </head>
 <body class="article toc2 toc-left">
 <div id="header">
-<h1>The F Prime Prime (FPP) Language Specification</h1>
+<h1>The F Prime Prime (FPP) Language Specification, v0.1.0</h1>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
 <ul class="sectlevel1">
@@ -7613,7 +7613,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">20.4. Translation Tools</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2020-08-19 13:39:06 -0700
+Last updated 2020-09-28 11:35:00 -0700
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">

diff --git a/docs/spec/defs.sh b/docs/spec/defs.sh
@@ -4,6 +4,9 @@
 # defs.sh
 # ----------------------------------------------------------------------
 
+export LEVEL=../..
+. $LEVEL/defs.sh
+
 redo-ifchange defs.sh
 
 export FILES="

diff --git a/docs/spec/fpp-spec.adoc.do b/docs/spec/fpp-spec.adoc.do
@@ -8,11 +8,11 @@
 
 redo-ifchange $FILES
 
-echo '= The F Prime Prime (FPP) Language Specification
+echo "= The F Prime Prime (FPP) Language Specification, $VERSION
 :toc: left
 :toclevels: 3
 :stem:
-:source-highlighter: prettify'
+:source-highlighter: prettify"
 for file in $FILES
 do
   echo

diff --git a/docs/users-guide/defs.sh b/docs/users-guide/defs.sh
@@ -4,6 +4,9 @@
 # defs.sh
 # ----------------------------------------------------------------------
 
+export LEVEL=../..
+. $LEVEL/defs.sh
+
 redo-ifchange defs.sh
 
 export FILES="

diff --git a/docs/users-guide/fpp-users-guide.adoc.do b/docs/users-guide/fpp-users-guide.adoc.do
@@ -8,7 +8,7 @@
 
 redo-ifchange $FILES
 
-echo "= The F Prime Prime (FPP) User's Guide
+echo "= The F Prime Prime (FPP) User's Guide, $VERSION
 :toc: left
 :toclevels: 3
 :stem: