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.

Sign up for GitHub

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

Jump to bottom

Add new API Documentation Generation #541

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Add new API Documentation Generation #541

wants to merge 9 commits into from
+144 −19

Conversation

lawrence-mbf
Copy link
Collaborator

Fixes #417

Motivation

Add an easily automatable replacement for the crappy autogenerated MATLAB API docs.

How to test the behavior?

Checklist

  • Have you ensured the PR description clearly describes the problem and solutions?
  • Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
  • If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

@codecov
Copy link

codecov bot commented Sep 7, 2023 •
edited
Loading

Codecov Report

Merging #541 (d9bfb27) into master (a80f0aa) will not change coverage.
The diff coverage is n/a.

❗ Current head d9bfb27 differs from pull request most recent head 5b4a2fb. Consider uploading reports for the commit 5b4a2fb to get more accurate results

@@           Coverage Diff           @@
##           master     #541   +/-   ##
=======================================
  Coverage   87.78%   87.78%           
=======================================
  Files         132      132           
  Lines        5626     5626           
=======================================
  Hits         4939     4939           
  Misses        687      687

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

📢 Have feedback on the report? Share it here.

@lawrence-mbf lawrence-mbf changed the title Add ReadTheDocs for API Documentation Generation Add new API Documentation Generation Sep 7, 2023
@lawrence-mbf
Workaround permissions
9559cbc 
- Remove files that are not even runnable in ci.
- move sphinx-build call into pipeline yaml
@lawrence-mbf
remove unused step
03519c8
@lawrence-mbf
Refactor pipelines
5b4a2fb 
- Simplify sphinx-build call and flatten directory structure.
- Creating artifact api-pages
@lawrence-mbf lawrence-mbf mentioned this pull request Sep 7, 2023
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move docs to use Sphinx
1 participant
@lawrence-mbf