orderly-sdk-py/pdoc.conf at master · longcipher/orderly-sdk-py · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Pdoc configuration for Orderly SDK
# This file customizes the generated documentation

# Use Google-style docstrings
docformat = "google"

# Show source code links
show_source = true

# Enable search functionality
search = true

# Include private members (starting with _) if they have docstrings
include_undocumented = false

# Sort identifiers alphabetically
sort_identifiers = true

# Enable math rendering
math = true

# Custom CSS for better styling
template_directory = ".github/pdoc_templates"

# Footer text
footer_text = """
<p>
Orderly SDK for Python -
<a href="https://github.com/longcipher/orderly-sdk-py">GitHub</a> |
<a href="https://pypi.org/project/orderly-sdk/">PyPI</a> |
<a href="https://orderly.network/docs/build-on-evm/building-on-evm">Official API Docs</a>
</p>
"""