diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e8ee4d6..5a6db91 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -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 }} diff --git a/.gitignore b/.gitignore index 45e0359..6083fe2 100644 --- a/.gitignore +++ b/.gitignore @@ -72,7 +72,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +docs/en/_build/ # PyBuilder .pybuilder/ diff --git a/README.md b/README.md index 206ef55..50e4f2d 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/Makefile b/docs/en/Makefile similarity index 100% rename from docs/Makefile rename to docs/en/Makefile diff --git a/docs/_static/css/readthedocs.css b/docs/en/_static/css/readthedocs.css similarity index 100% rename from docs/_static/css/readthedocs.css rename to docs/en/_static/css/readthedocs.css diff --git a/docs/abbreviation.md b/docs/en/abbreviation.md similarity index 100% rename from docs/abbreviation.md rename to docs/en/abbreviation.md diff --git a/docs/api.rst b/docs/en/api.rst similarity index 100% rename from docs/api.rst rename to docs/en/api.rst diff --git a/docs/conf.py b/docs/en/conf.py similarity index 97% rename from docs/conf.py rename to docs/en/conf.py index 604b521..6fae834 100644 --- a/docs/conf.py +++ b/docs/en/conf.py @@ -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(): diff --git a/docs/customization.md b/docs/en/customization.md similarity index 100% rename from docs/customization.md rename to docs/en/customization.md diff --git a/docs/index.rst b/docs/en/index.rst similarity index 100% rename from docs/index.rst rename to docs/en/index.rst diff --git a/docs/installation.md b/docs/en/installation.md similarity index 100% rename from docs/installation.md rename to docs/en/installation.md diff --git a/docs/make.bat b/docs/en/make.bat similarity index 100% rename from docs/make.bat rename to docs/en/make.bat