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

Use Sphinx Immaterial's python-apigen for API Reference #370

Merged
merged 11 commits into from
Jul 14, 2022

Conversation

mhostetter
Copy link
Owner

No description provided.

@mhostetter mhostetter added the documentation Improvements or additions to documentation label Jul 12, 2022
@codecov
Copy link

codecov bot commented Jul 12, 2022

Codecov Report

Merging #370 (6a26c2d) into master (740f888) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #370      +/-   ##
==========================================
- Coverage   96.70%   96.69%   -0.01%     
==========================================
  Files          42       42              
  Lines        5220     5211       -9     
==========================================
- Hits         5048     5039       -9     
  Misses        172      172              
Impacted Files Coverage Δ
galois/_codes/_linear.py 92.85% <ø> (ø)
galois/_fields/_factory.py 96.52% <ø> (ø)
galois/_fields/_gf2.py 100.00% <ø> (ø)
galois/_math.py 97.89% <ø> (ø)
galois/_modular.py 93.42% <ø> (ø)
galois/_ntt.py 98.30% <ø> (ø)
galois/_options.py 100.00% <ø> (ø)
galois/_polymorphic.py 97.61% <ø> (ø)
galois/_polys/_functions.py 100.00% <ø> (ø)
galois/_polys/_irreducible.py 100.00% <ø> (ø)
... and 18 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84ca4e1...6a26c2d. Read the comment docs.

@mhostetter mhostetter marked this pull request as draft July 12, 2022 17:43
@mhostetter mhostetter marked this pull request as draft July 12, 2022 17:43
Previously for some strange reason Sphinx required forward references in type annotations, eg "FieldArray". Without this the type signature would not link or be shortened, eg "galois._fields._array.FieldArray". Now with Sphinx 5.0 this is no longer necessary.
They are moved to private functions instead. This helps clean up `dir()` on `FieldArray`.
@mhostetter mhostetter marked this pull request as ready for review July 14, 2022 22:01
@mhostetter mhostetter merged commit 7a50cc1 into master Jul 14, 2022
@mhostetter mhostetter deleted the python-apigen branch July 14, 2022 22:19
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.

Class properties' autosummary table doesn't include docstring preview
1 participant