[DOCS] Add API Reference Page #17
Merged
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
TheCedarPrince
added
documentation
Codecov ReportPatch and project coverage have no change.
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## dev #17 +/- ##
=====================================
Coverage 0.62% 0.62%
=====================================
Files 3 3
Lines 159 159
=====================================
Hits 1 1
Misses 158 158 ☔ View full report in Codecov by Sentry. |
TheCedarPrince
added a commit
that referenced
this pull request
Aug 31, 2023
* Documentation coverage (#9) * Initial documentation bits Initial bits of documentation to get started and kick this off. * Reverted back to main branch version * Rewrote motivation to index Per suggestions in PR #9, the motivation.md file content has been moved to the index.md file and rewritten to both be more document storage-format agnostic and place an empathis on digidal garden creation earlier on. I also expanded it with some general ideas on the vision of where NoteMate could be expanded to. * Delete settings.json Should not be part of any commits * second part did not stage into commit go figure. Workflow is a bit unstable today. * Revision of docs landing page (#13) * Revision of docs landing page * Minor refactor for initial draft * Docstrings for files (#11) * Initial documentation bits Initial bits of documentation to get started and kick this off. * Cleaned up docstrings branch * Added docstrings to rest of franklin.jil Rolled the improved docstrings by @TheCedarPrince into the existing docstrings, and added docstrings of the same style to the rest of the methods. Docstring for generate_citation() still requires a clarification for the citations keyword argument - structure of the agument data unclear. * Added docsstrings for remaining functions We should now have docstring coverage across the entire NoteMate module. * [DOCS] Add API Reference Page (#17) * Added LiveServer dependency for easier local documentation previews * Added link to API reference page * Added API reference section * Added first draft of README (#20) * [DOCS] Example Workflow Showing What `NoteMate.jl` Can Do (#26) * Writing initial usage documentation Using the example workflow Julia parser, wrote a how to use document. Not yet hyperlinked to any other pages. * Stubbing out parsing component * Drafting first pass of NoteMate structure document * Expanding using notemate tutorial * Finished initial pass through and added todos * Added tutorial section * Finalized initial tutorial * Added resources for documentation * Updated package versions and added Markdown dependency --------- Co-authored-by: Sevoris Doe <74614227+SevorisDoe@users.noreply.github.com> * [FEATURE] Added Templates and Changelog (#29) * Added templates for feature requests and bug reports * Updated installation instructions * Drafted initial Changelog * Added a pull request template for future contributors * Added tag for initial release * Removed additional dependenices for initial package release * Added test dependencies * Added first attempt at a test suite for package * Test assets for the test suite --------- Co-authored-by: Sevoris Doe <74614227+SevorisDoe@users.noreply.github.com>
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.
This PR adds an API reference page for current functions exported and organized within
NoteMate.jl.