mmengine/docs
Tao Gong f9158e233e
[Docs] Add English docs of BaseDataset (#713)
* 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
..
en [Docs] Add English docs of BaseDataset (#713) 2022-11-15 20:20:46 +08:00
resources/config [Docs] Refine config docs. (#432) 2022-08-30 18:39:19 +08:00
zh_cn [Docs] Add English docs of BaseDataset (#713) 2022-11-15 20:20:46 +08:00
README.md [Doc]: fix typo in installation command (#433) 2022-08-16 15:42:27 +08:00

README.md

Build Documentation

  1. Clone MMEngine

    git clone https://github.com/open-mmlab/mmengine.git
    cd mmegnine
    
  2. Install the building dependencies of documentation

    pip install -r requirements/docs.txt
    
  3. Change directory to docs/en or docs/zh_cn

    cd docs/en  # or docs/zh_cn
    
  4. Build documentation

    make html
    
  5. Open _build/html/index.html with browser