Skip to content

Autogenerate api docs#4097

Open
je-cook wants to merge 18 commits intoukaea:mainfrom
je-cook:autoapi
Open

Autogenerate api docs#4097
je-cook wants to merge 18 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
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 96.10390% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 46.73%. Comparing base (9b6c78a) to head (f33e6e3).

Files with missing lines Patch % Lines
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.57%   46.73%   +0.16%     
==========================================
  Files         124      124              
  Lines       29042    29132      +90     
==========================================
+ Hits        13526    13615      +89     
- Misses      15516    15517       +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

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.

Fix vardes Keep documentation up-to-date automatically

3 participants