https://github.com/agoraio-extensions/iris_doc
https://github.com/agoraio-extensions/iris_doc
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/agoraio-extensions/iris_doc
- Owner: AgoraIO-Extensions
- License: mit
- Created: 2024-11-05T07:05:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-14T09:49:24.000Z (about 1 year ago)
- Last Synced: 2025-05-14T10:53:09.502Z (about 1 year ago)
- Language: Python
- Size: 258 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iris_doc
A CLI tool that fill the dita json data as comments to code from https://github.com/AgoraIO/agora_doc_source.
## Get Started
### dart
```
python3 -m pip install -r requirements.txt
python3 iris_doc.py \
--config=fmt_config/fmt_dart.yaml \
--language=dart \
--template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/flutter_ng_json_template_cn.json \
--export-file-path=/Users/exportfile/path/export_file.dart
```
### ts
First install the eslint
```
npm install eslint
```
```
python3 -m pip install -r requirements.txt
python3 iris_doc.py \
--config=fmt_config/fmt_ts.yaml \
--language=ts \
--template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/rn_ng_json_template_en.json \
--export-file-path=/Users/exportfile/path/export_file.ts
```
### c_sharp
First install the clang
```
python3 -m pip install -r requirements.txt
python3 iris_doc.py \
--config=fmt_config/fmt_c_sharp.yaml \
--language=c_sharp \
--template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/unity_ng_doc_template_en.json \
--export-file-path=/Users/exportfile/path
```
## License
The project is under the MIT license.