Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code documentation support #471

Open
wants to merge 33 commits into
base: glad2
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
768fda8
add docs flag
paoloose May 13, 2024
67a5683
add utils
paoloose May 14, 2024
283ce5b
update .gitignore
paoloose May 14, 2024
148070e
integrate code documentation
paoloose May 14, 2024
0034c22
add support for doc comments on template
paoloose May 14, 2024
4129015
add docsgl documentation
paoloose May 17, 2024
7fca80c
improve templating
paoloose May 17, 2024
c1f7e86
make text parsing utilities more versatile
paoloose May 18, 2024
a8fc033
support custom break logic for templates
paoloose May 18, 2024
ec699c1
implement DocsGL documentation
paoloose May 18, 2024
5977606
fix parsing for descriptions with multiple parameters
paoloose May 18, 2024
f2c4fbb
fully parse doc params description
paoloose May 18, 2024
0e267f7
fix crash when no --with-docs is present
paoloose May 18, 2024
947a8f0
fix pipe format for templates
paoloose May 18, 2024
48d8bab
rename ApiDocumentation to SpecificationDocs
paoloose May 18, 2024
3a15146
only load documentation if --with-docs is present
paoloose May 18, 2024
3cd03ec
fix <dt> listing format
paoloose May 19, 2024
d87dfc4
improve parsing and add basic support for equations
paoloose May 22, 2024
300b6fe
revert specification load change
paoloose May 25, 2024
5b5798c
remove specification-docs dependency
paoloose May 25, 2024
c71a789
refactor: pass docs to generator.generate instead of the specification
paoloose May 26, 2024
0c956e2
change docs out dir from .cached to .docs
paoloose May 26, 2024
29a8ee7
make --with-docs a global option since it's language agnostic
paoloose May 26, 2024
9aa3dbd
fix: log warning when no documentation is found for the spec
paoloose May 26, 2024
b728972
fix docs rendering
paoloose May 26, 2024
5b73a9f
prefer lxml instead of xml package
paoloose May 26, 2024
13e26fd
replace DocsGL with Khronos refpages
paoloose May 26, 2024
57c5ead
fix parameters parsing and math namespacing
paoloose Jun 2, 2024
cbdb5a6
rename --with-docs to --docs
paoloose Jun 2, 2024
70740de
don't xinclude by default when parsing xml from file
paoloose Jun 2, 2024
37409b4
drop dependency lxml
paoloose Jun 2, 2024
4a24403
implement requested changes
paoloose Jun 2, 2024
4ac233b
improve readability and add comments for reference
paoloose Jun 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fully parse doc params description
paoloose committed May 18, 2024
commit f2c4fbb5f4a917a943eed145a108054b578f1917
2 changes: 1 addition & 1 deletion glad/documentation.py
Original file line number Diff line number Diff line change
@@ -125,7 +125,7 @@ def docs_from_html_file(cls, path):
if params_block is not None:
for names, desc in zip(
params_block.findall('.//dl//dt'),
params_block.findall('.//dl//dd/p'),
params_block.findall('.//dl//dd'),
):
for name in names.findall('.//code'):
param_name = raw_text(name)