Skip to content
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

Build mindocr online doc webpage #393

Merged
merged 5 commits into from
Jun 21, 2023
Merged

Conversation

HaoyangLee
Copy link
Collaborator

@HaoyangLee HaoyangLee commented Jun 14, 2023

Thank you for your contribution to the MindOCR repo.
Before submitting this PR, please make sure:

Motivation

After merging, the repo will compile the mkdocs.yml and generate a new branch 'gh-pages' for the online doc webpage.
Sample: https://haoyanglee.github.io/mindocr/

@SamitHuang
Copy link
Collaborator

建议调整docs/en 和 docs/zh下的目录结构,将make_docs下的文档按git io的栏目去划分:如 get_started, tutorials, api

@@ -0,0 +1 @@
{% include-markdown "../../../mindocr/data/transforms/README.md" %}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

现在很多readme都只有英文的,这里本来应该链接中文,现在只能链接英文,后续是否要补充中文readme?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

需要补充中文的

| dbnet_resnet18 |detection| icdar2015 | 83.71 | [config](https://github.com/mindspore-lab/mindocr/tree/main/configs/det/dbnet) |
| dbnet_resnet50 |detection| icdar2015 | 84.99 | [config](https://github.com/mindspore-lab/mindocr/tree/main/configs/det/dbnet) | [link](https://gitee.com/mindspore/models/tree/r2.0/official/cv/DBNet/) |
| dbnet_resnet50 |detection| msra-td500 | 85.03 | [config](https://github.com/mindspore-lab/mindocr/tree/main/configs/det/dbnet) |
| dbnet++_resnet50 |detection| icdar2015 | 86.60 | [config](https://github.com/mindspore-lab/mindocr/tree/main/configs/det/dbnet) |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

模型列表的模型只写这几个吗?很多数据集的规格现在都支持,需要写吗?

Copy link
Collaborator Author

@HaoyangLee HaoyangLee Jun 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

此处主要体现所支持的模型有哪些。所有数据集的支持可在configs里查看。

@HaoyangLee HaoyangLee force-pushed the mkdocs branch 7 times, most recently from 2781719 to 9652fde Compare June 19, 2023 13:01
Build online docs

Build online docs

add mkdocs.yml

add mkdocs workflow

update mkdocs.yml

build mkdocs successfully, but not perfect

update main page readme format

update mkdocs

update tutorials

update sections and contents

precommit formatting

update mainpage

precommit format

updates

updates

update <details open markdown> in .md files

delete useless mkdocs links, because no cn en suffix in filename in docs/

remove language switch tab of docs in `docs/`

update jump link of docs in docs/

small updates

fix README_CN.md

change internal section link way

remove files
@HaoyangLee HaoyangLee changed the title Add mindocr doc's webpage Build mindocr online doc webpage Jun 19, 2023
@HaoyangLee
Copy link
Collaborator Author

HaoyangLee commented Jun 19, 2023

建议调整docs/en 和 docs/zh下的目录结构,将make_docs下的文档按git io的栏目去划分:如 get_started, tutorials, api

docs/cn/mkdocs/目录下的文档只是为了适配mkdocs工具的语法,为不在docs/目录下的文档提供跳转链接。

@HaoyangLee HaoyangLee merged commit f2466c5 into mindspore-lab:main Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants