Skip to content

Commit e7a5b5a

Browse files
committed
doc: notable improvements to API documentation generation (added search, branding, a little styling)
Signed-off-by: Paul Horton <[email protected]>
1 parent a152852 commit e7a5b5a

File tree

5 files changed

+468
-1
lines changed

5 files changed

+468
-1
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535

3636
- name: Build documentation
3737
run: |
38-
poetry run pdoc --html cyclonedx
38+
poetry run pdoc --template-dir doc/templates --html cyclonedx
3939
- name: Deploy documentation
4040
uses: JamesIves/[email protected]
4141
with:

doc/templates/config.mako

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<%!
2+
3+
git_link_template = 'https://github.com/cyclonedx-python-lib/blob/{commit}/{path}#L{start_line}-L{end_line}'
4+
5+
google_search_query = '''
6+
site:cyclonedx.github.io
7+
inurl:github.com/cyclonedx/cyclonedx-python-lib
8+
'''
9+
10+
%>

0 commit comments

Comments
 (0)