doc: Minor doxygen fixes

Signed-off-by: Siddharth Chandrasekaran <[email protected]>

doc/Doxyfile.in

@@ -246,7 +246,7 @@ ALIASES                =
 # members will be omitted, etc.
 # The default value is: NO.
 
-OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
 
 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
 # Python sources only. Doxygen will then generate output that is more tailored
@@ -322,7 +322,7 @@ AUTOLINK_SUPPORT       = YES
 # diagrams that involve STL classes more complete and accurate.
 # The default value is: NO.
 
-BUILTIN_STL_SUPPORT    = NO
+BUILTIN_STL_SUPPORT    = YES
 
 # If you use Microsoft's C++/CLI language, you should set this option to YES to
 # enable parsing support.
@@ -429,7 +429,7 @@ LOOKUP_CACHE_SIZE      = 0
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.

doc/index.rst

@@ -124,6 +124,7 @@ of the protocol support only the most common among them. You can see a
 
    api/control-panel
    api/peripheral-device
+   api/pd-info
    api/miscellaneous
    api/command-structure
    api/event-structure

doc/libosdp/build-and-install.rst

@@ -148,7 +148,7 @@ and the C++ community. A port for LibOSDP has already been merged to vcpkg
 upstream -- this means you can consume LibOSDP directly from vcpkg and use all
 the generators it supports.
 
-Follow the `getting started document _DOC>`_ from Microsoft to setup vckpg.
+Follow the `getting started document <_DOC>`_ from Microsoft to setup vckpg.
 After that, you careate a new application and pull in LibOSDP as a dependency.
 
 .. _DOC: https://learn.microsoft.com/en-us/vcpkg/get_started/get-started

scripts/make-html-docs.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+SCRIPTS_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+ROOT_DIR="${SCRIPTS_DIR}/../"
+
+pushd "${ROOT_DIR}/doc"
+rm -rf .venv __pycache__
+python3 -m venv .venv
+source ./.venv/bin/activate
+pip install -r requirements.txt
+
+cmake -B build ..
+cmake --build build -t html_docs
+mv build/doc/sphinx/ .
+rm -rf build
+mv sphinx build

scripts/run_tests.sh

@@ -2,8 +2,8 @@
 
 set -e
 
-TEST_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
-ROOT_DIR="${TEST_DIR}/../"
+SCRIPTS_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+ROOT_DIR="${SCRIPTS_DIR}/../"
 
 function run_make_check() {
 	echo "[-] Running make check"
@@ -23,7 +23,7 @@ function run_cmake_unit_test() {
 
 function run_pytest() {
 	echo "[-] Creating an isolated environment.."
-	pushd ${TEST_DIR}
+	pushd ${SCRIPTS_DIR}
 	rm -rf __pycache__/
 	rm -rf .venv ${ROOT_DIR}/python/{build,dist,libosdp.egg-info,vendor}
 	python3 -m venv .venv