doc: notable improvements to API documentation generation (added sear…

…ch, branding, a little styling) Signed-off-by: Paul Horton <[email protected]>
CycloneDX · Oct 12, 2021 · e7a5b5a · e7a5b5a
1 parent a152852
commit e7a5b5a
Show file tree

Hide file tree

Showing 5 changed files with 468 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -35,7 +35,7 @@ jobs:
 
       - name: Build documentation
         run: |
-          poetry run pdoc --html cyclonedx
+          poetry run pdoc --template-dir doc/templates --html cyclonedx
       - name: Deploy documentation
         uses: JamesIves/[email protected]
         with:

diff --git a/doc/templates/config.mako b/doc/templates/config.mako
@@ -0,0 +1,10 @@
+<%!
+
+git_link_template = 'https://github.com/cyclonedx-python-lib/blob/{commit}/{path}#L{start_line}-L{end_line}'
+
+google_search_query = '''
+    site:cyclonedx.github.io
+    inurl:github.com/cyclonedx/cyclonedx-python-lib
+'''
+
+%>