docs: add API documentation for benchmarking (#21)

* docs: add API documentation for benchmarking

Signed-off-by: Elizabeth J Lee <[email protected]>

Author: ejlee3

Dockerfile.docs

@@ -7,9 +7,17 @@
 # Useful for local testing
 
 FROM python:3-slim
-RUN apt-get update && apt-get install --no-install-recommends -y git \
-  && pip install mkdocs "mkdocs-material>=8.2" "mkdocs-htmlproofer-plugin>=0.8" "mkdocs-swagger-ui-tag" && \
+RUN apt-get update && apt-get install --no-install-recommends -y git wget unzip \
+  && pip install mkdocs "mkdocs-material>=8.2" "mkdocs-htmlproofer-plugin>=0.8" \
+  "mkdocs-swagger-ui-tag" "mkdocstrings>=0.24.3" "mkdocstrings-python>=1.9.2" && \
   rm -rf /var/lib/apt/lists/*
+
+WORKDIR /apis
+RUN wget https://github.com/intel-retail/performance-tools/archive/refs/heads/main.zip
+RUN unzip main.zip
+WORKDIR /benchmark-scripts
+RUN mv /apis/performance-tools-main/benchmark-scripts/* .
+
 EXPOSE 8000
 ENTRYPOINT ["mkdocs"]
 CMD ["serve", "--dev-addr=0.0.0.0:8000"]

docs_src/performance-tools/api-docs.md

@@ -0,0 +1,8 @@
+# API Documentation for Benchmark Scripts
+
+## Benchmark Package
+
+::: benchmark
+    handler: python
+    options:
+        show_source: false

mkdocs.yml

@@ -4,7 +4,7 @@ repo_name: "intel-retail/documentation"
 repo_url: "https://github.com/intel-retail/documentation"
 docs_dir: ./docs_src
 site_dir: ./docs
-copyright: 'Copyright © 2023 Intel Corporation'
+copyright: 'Copyright © 2024 Intel Corporation'
 use_directory_urls: false
 theme:
   name: 'material'
@@ -27,8 +27,11 @@ theme:
     - toc.integrate
 plugins:
   - search
-repo_url: https://github.com/intel-retail/documentation
-repo_name: intel-retail/documentation
+  - mkdocstrings:
+      enable_inventory: true
+      handlers:
+        python:
+          paths: [../benchmark-scripts]
 nav:
   - Home: 'index.md'
   - Architecture Decisions:
@@ -41,6 +44,7 @@ nav:
           - Target Device: 'Architecture/target-device.md'
   - Performance Tools:
       - Benchmarking: 'performance-tools/benchmark.md'
+      - Benchmarking APIs: 'performance-tools/api-docs.md'
 extra_css:
   - ./stylesheets/index.css
   - https://fonts.googleapis.com/icon?family=Material+Icons