mirror of https://github.com/open-mmlab/mim.git
[Docs] Refactor the structure of the documentation (#94)
* [Docs] Refactor the structure of documentationpull/96/head
parent
6b9be66bdb
commit
08a99cff03
|
@ -7,6 +7,8 @@ on:
|
|||
- 'docs/**'
|
||||
- '.pre-commit-config.yaml'
|
||||
- '.readthedocs.yml'
|
||||
- '.gitigore'
|
||||
- 'LICENSE'
|
||||
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
|
@ -14,6 +16,8 @@ on:
|
|||
- 'docs/**'
|
||||
- '.pre-commit-config.yaml'
|
||||
- '.readthedocs.yml'
|
||||
- '.gitigore'
|
||||
- 'LICENSE'
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
|
|
|
@ -72,7 +72,7 @@ instance/
|
|||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
docs/en/_build/
|
||||
|
||||
# PyBuilder
|
||||
.pybuilder/
|
||||
|
|
|
@ -26,7 +26,7 @@ v0.1.1 was released in 13/6/2021.
|
|||
|
||||
## Customization
|
||||
|
||||
You can use `.mimrc` for customization. Now we support customize default values of each sub-command. Please refer to [customization.md](docs/customization.md) for details.
|
||||
You can use `.mimrc` for customization. Now we support customize default values of each sub-command. Please refer to [customization.md](docs/en/customization.md) for details.
|
||||
|
||||
## Build custom projects with MIM
|
||||
|
||||
|
@ -35,7 +35,7 @@ Without worrying about copying codes and scripts from existing codebases, users
|
|||
|
||||
## Installation
|
||||
|
||||
Please refer to [installation.md](docs/installation.md) for installation.
|
||||
Please refer to [installation.md](docs/en/installation.md) for installation.
|
||||
|
||||
## Command
|
||||
|
||||
|
|
|
@ -18,14 +18,14 @@ import sys
|
|||
#
|
||||
import pytorch_sphinx_theme
|
||||
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'mim'
|
||||
copyright = '2021, openmmlab'
|
||||
author = 'MIM Authors'
|
||||
version_file = '../mim/version.py'
|
||||
version_file = '../../mim/version.py'
|
||||
|
||||
|
||||
def get_version():
|
Loading…
Reference in New Issue