-
Notifications
You must be signed in to change notification settings - Fork 32
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 new API Documentation Generation #541
Draft
lawrence-mbf
wants to merge
9
commits into
master
Choose a base branch
from
add-readthedocs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ 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. |
Due to MATLAB API documentation requiring auto-generation of code.
lawrence-mbf
changed the title
Add ReadTheDocs for API Documentation Generation
Add new API Documentation Generation
Sep 7, 2023
- Remove files that are not even runnable in ci. - move sphinx-build call into pipeline yaml
- Simplify sphinx-build call and flatten directory structure. - Creating artifact api-pages
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #417
Motivation
Add an easily automatable replacement for the crappy autogenerated MATLAB API docs.
How to test the behavior?
Checklist
fix #XX
whereXX
is the issue number?