Skip to content

Commit

Permalink
Remove versioned Doxygen and gh_pages.py
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-bc committed Dec 4, 2024
1 parent 33d2a34 commit 745c76e
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 83 deletions.
3 changes: 1 addition & 2 deletions docs/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ PROJECT_NAME = "F´ Flight Software - C/C++ Documentation"
# could be handy for archiving the generated documentation or if some version
# control system is used.

# Replaced with version number by ./generate_docs.bash <VERSION>
PROJECT_NUMBER = devel
PROJECT_NUMBER =

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
9 changes: 1 addition & 8 deletions docs/doxygen/generate_docs.bash
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/bin/bash
####
# generate_docs.sh: A crude wrapper for generating fprime documents for API documents.
# This generates both the doxygen (C++) and CMake API documentation for fprime.
####
SOURCE_DIR=`dirname $BASH_SOURCE`

Expand All @@ -10,8 +11,6 @@ APIDOCS="${FPRIME}/docs/documentation/reference/api"
DOXY_OUTPUT="${APIDOCS}/cpp"
CMAKE_OUTPUT="${APIDOCS}/cmake"

VERSIONED_OUTPUT="${1:-}"

DOXYGEN="${2:-$(which doxygen)}"
if [ ! -x "${DOXYGEN}" ]
then
Expand Down Expand Up @@ -56,12 +55,6 @@ function clobber
fi
mkdir -p ${DOXY_OUTPUT}

# Replace version number in Doxyfile
if [[ "${VERSIONED_OUTPUT}" != "" ]]
then
sed -i "s/^PROJECT_NUMBER[ ]*=.*$/PROJECT_NUMBER=${VERSIONED_OUTPUT}/g" "${FPRIME}/docs/doxygen/Doxyfile"
fi

${DOXYGEN} "${FPRIME}/docs/doxygen/Doxyfile"
rm -r "${DOCS_CACHE}"
) || exit 1
Expand Down
73 changes: 0 additions & 73 deletions docs/doxygen/gh_pages.py

This file was deleted.

0 comments on commit 745c76e

Please sign in to comment.