Skip to content

Comments

Autogenerate api docs#4097

Merged
timothy-nunn merged 27 commits intoukaea:mainfrom
je-cook:autoapi
Feb 19, 2026
Merged

Autogenerate api docs#4097
timothy-nunn merged 27 commits intoukaea:mainfrom
je-cook:autoapi

Conversation

@je-cook
Copy link
Collaborator

@je-cook je-cook commented Feb 12, 2026

Description

Closes #3834
Closes #1532
Closes #3844
possibly also #2936

This

  • Adds auto api docs generation
  • removes most of the vardes stuff
  • converts all the docstrings to use the numpy docstring style because autoformatting of sphinx api docs is on the whole no supported by mkdocs (many features are missing).

Most of the docs changes were done automatically by the pyment package with some manual fixes afterwards.

This adds a few docs dependencies too.

Sorry its so long...

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@codecov-commenter
Copy link

codecov-commenter commented Feb 12, 2026

Codecov Report

❌ Patch coverage is 88.37209% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.83%. Comparing base (c150e7d) to head (418fe2a).

Files with missing lines Patch % Lines
process/io/plot_proc.py 66.66% 7 Missing ⚠️
process/io/costs_bar.py 0.00% 1 Missing ⚠️
process/io/data_structure_dicts.py 50.00% 1 Missing ⚠️
process/io/process_config.py 94.11% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4097      +/-   ##
==========================================
+ Coverage   46.67%   46.83%   +0.16%     
==========================================
  Files         136      136              
  Lines       29207    29297      +90     
==========================================
+ Hits        13633    13722      +89     
- Misses      15574    15575       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@je-cook je-cook force-pushed the autoapi branch 2 times, most recently from 9b2e456 to a039485 Compare February 13, 2026 08:57
@je-cook je-cook added the Documentation Improvements or additions to documentation label Feb 13, 2026
@je-cook je-cook marked this pull request as ready for review February 13, 2026 11:22
@je-cook je-cook requested a review from a team as a code owner February 13, 2026 11:22
Copy link
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

Couple of concerns before I continue reviewing. The auto converter seems to be not getting the formatting quite correct

@je-cook je-cook requested a review from timothy-nunn February 16, 2026 08:00
@je-cook je-cook force-pushed the autoapi branch 2 times, most recently from 8a1d45e to e1feefb Compare February 16, 2026 08:22
Copy link
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

A couple of comments from this batch of the review... 248/312 viewed 😆

We should probably make some issues/papercuts about enabling ruff rules for docstrings now that they will be in a somewhat sensible format.

A lot of the docstrings are empty... this could also be a recurring papercut where each sprint someone checks the docstrings of say 5 files

Comment on lines +409 to +418


Parameters
----------
output :

tf_radial_dim :

tf_vertical_dim :

Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to make an issue to fill these empty parameter sections in... sounds papercutty

Copy link
Collaborator

@timothy-nunn timothy-nunn left a comment

Choose a reason for hiding this comment

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

I haven't raised every single instance of :references:, some more will exist.

Some weird misalignments too.

That all the files currently checked.

je-cook and others added 4 commits February 19, 2026 10:53
Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>
Co-authored-by: Timothy <75321887+timothy-nunn@users.noreply.github.com>
@timothy-nunn timothy-nunn merged commit 2230706 into ukaea:main Feb 19, 2026
10 checks passed
@je-cook je-cook deleted the autoapi branch February 20, 2026 15:34
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.

Spelling mistakes in PROCESS Fix vardes Keep documentation up-to-date automatically

3 participants