docs: add jsdoc and rtd build #101
Merged
Conversation
This file contains hidden or 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
Bundle ReportChanges will increase total bundle size by 2.98kB (11.96%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: shared-web-array-pushAssets Changed:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #101 +/- ##
==========================================
- Coverage 98.37% 98.27% -0.10%
==========================================
Files 8 8
Lines 123 116 -7
Branches 32 31 -1
==========================================
- Hits 121 114 -7
Misses 2 2
|
ReenigneArcher
force-pushed
the
docs/add-jsdoc-and-rtd-build
branch
28 times, most recently
from
ae9e6f2 to
374a514
Compare
ReenigneArcher
force-pushed
the
docs/add-jsdoc-and-rtd-build
branch
8 times, most recently
from
db8b7cf to
95db90a
Compare
ReenigneArcher
force-pushed
the
docs/add-jsdoc-and-rtd-build
branch
13 times, most recently
from
b6d57f2 to
9d1ea28
Compare
ReenigneArcher
force-pushed
the
docs/add-jsdoc-and-rtd-build
branch
from
9d1ea28 to
4aec818
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation build configurations, automated workflows, and sample projects to support the shared-web documentation and examples using jsdoc, ReadTheDocs, Jekyll, Doxygen, and release automation.
- Introduces a new ReadTheDocs configuration with multiple build commands.
- Adds example projects for Jekyll and Doxygen along with associated configurations and asset initialization.
- Updates GitHub workflows for docs and release management.
Reviewed Changes
Copilot reviewed 37 out of 47 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .readthedocs.yaml | New RTD configuration with build commands for various documentation tools. |
| examples/jekyll/shared-web-jekyll.gemspec | Adds a gemspec file for the Jekyll example project. |
| examples/doxygen/sample.md | Provides a Doxygen sample project demonstrating widget integration. |
| .github/workflows/update-docs.yml | Introduces a new workflow for updating ReadTheDocs projects on release events. |
| examples/jekyll/_config.yml | Supplies Jekyll configuration for the sample site with custom theme settings. |
| examples/jekyll/Gemfile | Minimal Gemfile for the Jekyll example project. |
| examples/jekyll/index.md | A landing page markdown file for the Jekyll sample project. |
| examples/jekyll/assets/js/crowdin-init.js | JS file initializing the CrowdIn integration. |
| .github/workflows/ci.yml | Extends CI with a new release job invoking a custom create-release action. |
| examples/jekyll/assets/js/discord-init.js | JS file initializing Discord integration. |
Files not reviewed (10)
- .flake8: Language not supported
- examples/doxygen/Doxyfile: Language not supported
- examples/doxygen/header.html: Language not supported
- examples/doxygen/package.json: Language not supported
- examples/jekyll/package.json: Language not supported
- examples/sphinx/.rstcheck.cfg: Language not supported
- examples/sphinx/Makefile: Language not supported
- examples/sphinx/make.bat: Language not supported
- examples/sphinx/package.json: Language not supported
- examples/sphinx/requirements.txt: Language not supported
Comments suppressed due to low confidence (1)
examples/jekyll/shared-web-jekyll.gemspec:6
- [nitpick] The author name 'ReenigneArcher' might be misspelled; please verify if this is the intended identifier.
spec.authors = ["ReenigneArcher"]
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.
Description
Add jsdoc, readthedocs, and examples.
Screenshot
Issues Fixed or Closed
Type of Change
.github/...)Checklist