mirrors/mmengine
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmengine.git synced 2025-06-03 21:54:44 +08:00
Code Issues Projects Releases Wiki Activity
mmengine/docs
History
Zaida Zhou ed84dfd34d
[Refactor] Refactor fileio without breaking back compatibility (#533) 
* [Refactor] Refactor fileio but without breaking bc

* handle compatibility

* fix format

* modify io functions

* fix ut

* fix ut

* rename method names

* refine

* refine docstring

* fix ut in windows

* update ut

* minor fix

* ensure client is not None when closing it

* add more examples for list_dir_or_file interface

* refine docstring

* refine deprecated info

* fix ut

* add a description for lmdb docstring
2022-09-26 14:30:40 +08:00
..
en
[Refactor] Refactor fileio without breaking back compatibility (#533)
2022-09-26 14:30:40 +08:00
resources/config
[Docs] Refine config docs. (#432)
2022-08-30 18:39:19 +08:00
zh_cn
[Refactor] Refactor fileio without breaking back compatibility (#533)
2022-09-26 14:30:40 +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