Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
##
## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
## Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
## Laboratory LLC.
##
## This file is part of the Asynchronous Network Management System (ANMS).
Expand Down Expand Up @@ -37,23 +37,38 @@ jobs:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@v4
uses: actions/checkout@v6
with:
fetch-depth: 0
submodules: recursive
- name: Set up OS
run: |
sudo rm /var/lib/man-db/auto-update
sudo apt-get update && sudo apt-get install -y cmake make coreutils ruby asciidoctor graphviz inkscape dblatex docbook-xsl-ns xsltproc xmlstarlet
sudo gem install asciidoctor-diagram
sudo apt-get update
sudo apt-get install -y \
cmake make coreutils \
ruby asciidoctor graphviz plantuml inkscape \
dblatex xmlstarlet aspell
sudo gem install \
asciidoctor-diagram \
'asciidoctor-diagram-plantuml:~>1.2024.8'
- name: Build
env:
DESTDIR: public
run: ./build.sh
- uses: actions/upload-artifact@v4
- name: Misspelling
run: ./build.sh docs-spelling
- uses: actions/upload-artifact@v7
with:
name: docs
path: public
- uses: actions/upload-artifact@v7
with:
archive: false
path: public/product-guide/anms-product-guide.pdf
- uses: actions/upload-artifact@v7
with:
archive: false
path: public/user-guide/anms-user-guide.pdf

deploy:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
Expand All @@ -73,16 +88,16 @@ jobs:
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-24.04
steps:
- uses: actions/download-artifact@v4
- uses: actions/download-artifact@v8
with:
name: docs
path: public
- name: Setup Pages
uses: actions/configure-pages@v3
uses: actions/configure-pages@v6
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
uses: actions/upload-pages-artifact@v5
with:
path: public
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v5
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
##
## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
## Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
## Laboratory LLC.
##
## This file is part of the Asynchronous Network Management System (ANMS).
Expand Down
18 changes: 16 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#[[
Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
Laboratory LLC.

This file is part of the Asynchronous Network Management System (ANMS).
Expand All @@ -24,10 +24,24 @@ cmake_minimum_required(VERSION 3.16)
project(anms-docs LANGUAGES )
set(CMAKE_INSTALL_PREFIX "")

include(FetchContent)
FetchContent_Declare(
xsltng
URL https://codeberg.org/DocBook/xslTNG/releases/download/2.8.0/docbook-xslTNG-2.8.0.zip
URL_HASH SHA256=adbbddbf33a4fcc5c949a2851cac53e8111d30a5fd0b32429eeec68aedb61efd
DOWNLOAD_EXTRACT_TIMESTAMP OFF
)
FetchContent_MakeAvailable(xsltng)
file(GLOB xsltng_JAR "${xsltng_SOURCE_DIR}/libs/*.jar")
if(NOT xsltng_JAR)
message(FATAL_ERROR "No xslTNG jar file found under ${xsltng_SOURCE_DIR}")
endif(NOT xsltng_JAR)

add_subdirectory(user-guide)
add_subdirectory(product-guide)

install(
FILES index.html
FILES deploy-index.html
RENAME index.html
DESTINATION .
)
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
Laboratory LLC.

This file is part of the Asynchronous Network Management System (ANMS).
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
Laboratory LLC.

This file is part of the Asynchronous Network Management System (ANMS).
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
Laboratory LLC.

This file is part of the Asynchronous Network Management System (ANMS).
Expand Down
4 changes: 2 additions & 2 deletions apply_license.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
##
## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
## Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
## Laboratory LLC.
##
## This file is part of the Asynchronous Network Management System (ANMS).
Expand Down Expand Up @@ -33,7 +33,7 @@ set -e
SELFDIR=$(realpath $(dirname "${BASH_SOURCE[0]}"))

LICENSEOPTS="${LICENSEOPTS} --tmpl ${SELFDIR}/apply_license.tmpl"
LICENSEOPTS="${LICENSEOPTS} --years 2023-$(date +%Y)"
LICENSEOPTS="${LICENSEOPTS} --years 2023-2026"
# Excludes only apply to directory (--dir) mode and not file mode
#LICENSEOPTS="${LICENSEOPTS} --exclude *.yml "

Expand Down
40 changes: 34 additions & 6 deletions build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
##
## Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
## Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
## Laboratory LLC.
##
## This file is part of the Asynchronous Network Management System (ANMS).
Expand All @@ -25,11 +25,39 @@
set -e

SELFDIR=$(realpath $(dirname "${BASH_SOURCE[0]}"))

cd ${SELFDIR}
cmake -S . -B build
cmake --build build $@
if [[ -n "${DESTDIR}" ]]

if [[ "$1" == "docs-spelling" ]]
then
cmake --install build
USER_MISSPELLING_TXT="build/user-guide/misspelling.txt"
USER_MISSPELLING_CTX_TXT="build/user-guide/misspelling-ctx.txt"
PROD_MISSPELLING_TXT="build/product-guide/misspelling.txt"
PROD_MISSPELLING_CTX_TXT="build/product-guide/misspelling-ctx.txt"
# success means file is present and empty
FAILURES=0
if [[ -s "${USER_MISSPELLING_TXT}" ]]
then
printf "\nUser guide:\n"
cat "${USER_MISSPELLING_TXT}"
printf "\nIn context:\n"
cat "${USER_MISSPELLING_CTX_TXT}"
((FAILURES += 1))
fi
if [[ -s "${PROD_MISSPELLING_TXT}" ]]
then
printf "\nProduct guide:\n"
cat "${PROD_MISSPELLING_TXT}"
printf "\nIn context:\n"
cat "${PROD_MISSPELLING_CTX_TXT}"
((FAILURES += 1))
fi
exit ${FAILURES}
else
# actual build
cmake -S . -B build
cmake --build build "$@"
if [[ -n "${DESTDIR}" ]]
then
cmake --install build
fi
fi
4 changes: 2 additions & 2 deletions index.html → deploy-index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<!--
-- Copyright (c) 2023-2025 The Johns Hopkins University Applied Physics
-- Copyright (c) 2023-2026 The Johns Hopkins University Applied Physics
-- Laboratory LLC.
--
-- This file is part of the Asynchronous Network Management System (ANMS).
Expand All @@ -20,7 +20,7 @@
-- the prime contract 80NM0018D0004 between the Caltech and NASA under
-- subcontract 1658085.
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>Index</title>
Expand Down
Loading
Loading