Conversation
- delete the origin `docs/README.md` for no use - update code example in project README.md
- Change PR title prefix from `doc` to `docs`, and update all corresponding configurations in `pr-title-checker-config.json` and `release-drafter.yml`.
- Replace the branching strategy gif with drawio diagram for better visual experience and less loading time - Update `.gitignore` to exclude drawio cache files - Update `setup.cfg` to include `mkdocs-drawio-exporter` as a docs dependency
… files - Add `cheatsheet.md` with detailed explanations of default configuration, tree level index, tree node attributes, and unit explanations - Update `demo.ipynb` with reference to new cheatsheet section - Add `MathJax` support for mathematical equations in documentation - Update `mkdocs.yml` to include new cheatsheet page and enable `MathJax` scripts
- Update reference link in PR guideline and Issue guideline - Fix indent error in `torchmeter.core`
- Improve compatibility information display - Update code snippets and clarify usage instructions - Embed asciinema demo instead of GIF - Update links to example notebooks and other resources - Add license icon in homepage footer - Delete the unnecessary dependency - `mkdocs-asciinema-player`
- Hide TOC in `thanks_contributors.md` - Hide navigation and TOC in `welcome_contributors.md`
- Update conventions link in PR title linter configuration - Update `README` with new contribution content - Reformat `torchmeter.core` - Remove unused `default_cfg.yaml` softlink - Replace `:man_raising_hand:` with emoji in the whole docs - Replace unrenderable icons with the renderable ones in `other/management.md`
- Update site URL and remote repository URL - Change alias_type from `symlink` to `redirect` - Remove `deploy_prefix`
github-actions
Bot
added
the
PR-title-needs-formatting
Coverage Details on macos under Python 3.8
Summary (on
|
| Tests | Skipped | Failures | Errors | Time |
|---|---|---|---|---|
| 806 | 2 💤 | 0 ❌ | 0 🔥 | 6.912s ⏱️ |
Ahzyuan
added
docs
Coverage Details on ubuntu under Python 3.8
Summary (on
|
| Tests | Skipped | Failures | Errors | Time |
|---|---|---|---|---|
| 806 | 2 💤 | 0 ❌ | 0 🔥 | 12.362s ⏱️ |
Coverage Details on windows under Python 3.8
Summary (on
|
| Tests | Skipped | Failures | Errors | Time |
|---|---|---|---|---|
| 806 | 2 💤 | 0 ❌ | 0 🔥 | 12.729s ⏱️ |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 all docs-related files.
The docs of
Torchmeteris built bymkdocs, and adopt a distributed deploying strategy which separates the docs source files, docs assets and docs deployment in different places to facilitate docs renewal and management efficiency.