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

Add API documentation to zola docs and fix rust docs #619

Merged

Conversation

QuantumDancer
Copy link
Contributor

This closes #597

In addition to the API documentation, this PR also includes a few fixes to the rust documentation (missing code block, table not being rendered correctly due to rust-lang/rust#65802)

@QuantumDancer QuantumDancer added the documentation Improvements or additions to documentation label Jan 11, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jan 11, 2024

Codecov Report

Merging #619 (b827665) into main (02656d9) will decrease coverage by 0.03%.
The diff coverage is 0.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #619      +/-   ##
==========================================
- Coverage   62.97%   62.95%   -0.03%     
==========================================
  Files          46       46              
  Lines        5823     5825       +2     
  Branches       74       74              
==========================================
  Hits         3667     3667              
- Misses       2156     2158       +2     
Components Coverage Δ
apel_plugin 64.94% <ø> (ø)
auditor 81.31% <0.00%> (-0.06%) ⬇️
slurm_collector 65.82% <ø> (ø)
slurm_epilog_collector 0.00% <ø> (ø)
htcondor_collector ∅ <ø> (∅)
priority_plugin 36.00% <ø> (ø)

raghuvar-vijay
raghuvar-vijay previously approved these changes Jan 11, 2024
Copy link
Collaborator

@raghuvar-vijay raghuvar-vijay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks. LGTM! I just mentioned some suggestions.

@QuantumDancer
Copy link
Contributor Author

Thanks a lot for the suggestions. I've updated the docs accordingly.

@QuantumDancer QuantumDancer merged commit 102542f into ALU-Schumacher:main Jan 15, 2024
49 checks passed
@QuantumDancer QuantumDancer deleted the add-api-documentation branch February 2, 2024 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Web API endpoint documentation
3 participants