separate doc from main repo to doc repo

[PaParaZz1]

• separate doc from main repo(https://github.com/opendilab/DI-engine/) to doc repo(https://github.com/opendilab/DI-engine-docs)
• fix doc.yml on branch bug
• remove install.yml workflow

P.S. unittest can be ignored now, it will be fixed in another pull request.

[HansBug]

Well, is the seperated repository able to build and deploy documentation properly? As I know that the build process of the documentation is based on the source code (or you can say, the pip package), but there will be no source code in doc repo. I think you have to create github action in doc repo and pip install di-engine b4 make html, however another problem is the potential conflict of the versions in source repo and doc repo. What is your plan to solve it?

[HansBug]

Consider to make a sync with the version of doc repo?

[PaParaZz1]

just restrict to main branch now?

[HansBug]

Well if you need to edit code and doc, especially when you are using branch, this way may cause problem because the verison of doc not the same.

[PaParaZz1]

Well, is the seperated repository able to build and deploy documentation properly? As I know that the build process of the documentation is based on the source code (or you can say, the pip package), but there will be no source code in doc repo. I think you have to create github action in doc repo and pip install di-engine b4 make html, however another problem is the potential conflict of the versions in source repo and doc repo. What is your plan to solve it?

• There are 2 ways to generate doc:
  1. in main repo doc workflow, first install the current source code of DI-engine, then clone doc repo, generate and deploy doc.
  2. In doc repo, the user can install doc repo and source repo from the requirements of doc repo, there is DI-engine item. that is to say, just execute the next command:

  git clone https://github.com/opendilab/DI-engine-docs
  cd DI-engine-docs
  pip install -r requirements
  make html

3. Sync problem is indeed important, so we will prepare a mapping for main repo and doc repo(such as : 0.1.0, 0.1.1, ... , latest). And https://opendilab.github.io/DI-engine/ only shows the latest doc, other version docs will be managed in https://di-engine-docs.readthedocs.io .
4. BTW, for the chinese-version doc, what's your advice?

[HansBug]

Well, is the seperated repository able to build and deploy documentation properly? As I know that the build process of the documentation is based on the source code (or you can say, the pip package), but there will be no source code in doc repo. I think you have to create github action in doc repo and pip install di-engine b4 make html, however another problem is the potential conflict of the versions in source repo and doc repo. What is your plan to solve it?

• There are 2 ways to generate doc:

  1. in main repo doc workflow, first install the current source code of DI-engine, then clone doc repo, generate and deploy doc.
  2. In doc repo, the user can install doc repo and source repo from the requirements of doc repo, there is DI-engine item. that is to say, just execute the next command:

  git clone https://github.com/opendilab/DI-engine-docs
  cd DI-engine-docs
  pip install -r requirements
  make html

1. Sync problem is indeed important, so we will prepare a mapping for main repo and doc repo(such as : 0.1.0, 0.1.1, ... , latest). And https://opendilab.github.io/DI-engine/ only shows the latest doc, other version docs will be managed in https://di-engine-docs.readthedocs.io .
2. BTW, for the chinese-version doc, what's your advice?

I have another idea, you can consider to use submodule to bind the version of source and docs together. It is a simple way to sync. (Actually as I known, some of the open source python projects' documentation is just in the source repo, with a doc or docs directory as the repo's root path. So it may not be a problem to store these together)

In the problem of chinese documentation, you can see this official doc, it is usually called 'internationalization' : https://www.sphinx-doc.org/en/master/usage/advanced/intl.html

By the way, I'm think about the support of the different versions of ding, like the python language's official documentation, 3.5 to 3.9 can be looked up on the internet. You can see this: https://stackoverflow.com/questions/28849284/how-do-i-have-multiple-versions-of-my-doc-with-sphinx