Commit Graph

6 Commits (e461581e55b5e2cd32d3d4036400d0fe4adb47aa)

Author SHA1 Message Date
Evan f356b3c207
[Docs] Minor fixes in docs to remove or replace unicode chars with ascii chars ()
* Remove CN comments in EN docs code
* Replace some full-width unicode chars with half-width ascii chars
2023-03-26 13:59:26 +08:00
Qian Zhao c712070c90
[Docs] Resolve warnings in sphinx build ()
* add ZeroOptimizer to optim

* resolve `duplicate label` warnings

* upgrade docutils && shpinx to resolve `unknown directive or role` warnings

* fix typo

* resolve literal_block && heading warnings

* resolve json literal_block warnings

* resolve python literal_block warnings

* resolve bunches of reference warnings

* resolve bunches of docstring warnings

* resolve warnings in autosummary

* resolve remaining warnings in en docs

* resolve heading warnings in zh_cn docs

* resolve remaining warnings in zh_cn docs

* fix as comments

* fix as comments
2023-02-08 20:36:57 +08:00
Timothy f1152c8877
[Docs] Fix wrong links and typos in doc ()
* update link

* fix typos

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-12-12 15:38:58 +08:00
Zaida Zhou 65eb39bfc6
[Docs] Fix docstring format and rescale the image () 2022-12-08 14:29:27 +08:00
Tao Gong f9158e233e
[Docs] Add English docs of BaseDataset ()
* add chinese docs of BaseDataset

* fix typo

* fix lint

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update docs/en/advanced_tutorials/basedataset.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* Update basedataset.md

* Update basedataset.md

* Update basedataset.md

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
2022-11-15 20:20:46 +08:00
Zaida Zhou 458f6d684e
[Docs] Refactor docs structure ()
* [WIP] Refactor-docs-structure

* [Docs] Check link and fix rst  ()

* check link

* fix rst

* Fix conf.py

* Fix lint

* minor refine

* minor refine

* modify zh_readme and index.rst

* add migration exampls get_started design to en

* add tutorials to en

* correct chinese doc link

* Apply suggestions from code review

* Update docs/en/advanced_tutorials/distributed.md

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

Co-authored-by: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
2022-08-31 21:18:55 +08:00