modify IO document

.azure-pipelines/scripts/codeScan/pyspelling/lpot_dict.txt

@@ -2378,3 +2378,4 @@ constfold
 grappler
 amsgrad
 qoperator
+apis

README.md

@@ -167,7 +167,7 @@ Intel® Neural Compressor validated 420+ [examples](./examples) for quantization
       <td colspan="3" align="center"><a href="./docs/source/design.md">Architecture</a></td>
       <td colspan="2" align="center"><a href="https://github.com/intel/neural-compressor/tree/master/examples">Examples</a></td>
       <td colspan="2" align="center"><a href="./docs/source/bench.md">GUI</a></td>
-      <td colspan="2" align="center"><a href="./docs/source/api-introduction.md">APIs</a></td>
+      <td colspan="2" align="center"><a href="https://intel.github.io/neural-compressor/api-documentation/apis.html">APIs</a></td>
     </tr>
     <tr>
       <td colspan="5" align="center"><a href="https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-ai-linux/top.html">Intel oneAPI AI Analytics Toolkit</a></td>
@@ -194,7 +194,7 @@ Intel® Neural Compressor validated 420+ [examples](./examples) for quantization
   </thead>
   <tbody>
     <tr>
-        <td colspan="2" align="center"><a href="./docs/source/Quantization.md">Quantization</a></td>
+        <td colspan="2" align="center"><a href="./docs/source/quantization.md">Quantization</a></td>
         <td colspan="1" align="center"><a href="./docs/source/pruning.md">Pruning(Sparsity)</a></td> 
         <td colspan="2" align="center"><a href="./docs/source/distillation.md">Knowledge Distillation</a></td>
         <td colspan="2" align="center"><a href="./docs/source/mixed_precision.md">Mixed Precision</a></td>

docs/Makefile

@@ -19,17 +19,11 @@ help:
 
 html:
 	# cp README.md to docs, modify response-link
-	cp -f "../README.md" "./source/README.md"
+	cp -f "../README.md" "./source/getting_started.md"
 	cp -f "../SECURITY.md" "./source/SECURITY.md"
-	cp -f "./source/README.md" "./source/README.md.tmp"
-	sed 's/.md/.html/g; s/.\/docs\/source\//.\//g; s/.\/neural_coder\/extensions\/screenshots/imgs/g; s/.\/docs\/source\/_static/..\/\/_static/g; s/.\/examples/https:\/\/github.com\/intel\/neural-compressor\/tree\/master\/examples/g; s/.md/.html/g; ' "./source/README.md.tmp" > "./source/README.md"
-	rm -f "./source/README.md.tmp"
-
-	# modify docList
-	cp -f "./source/doclist.rst" "./source/doclist.rst.tmp"
-	sed 's/.md/.html/g;' "./source/doclist.rst.tmp" > "./source/doclist.rst"
-	rm -f "./source/doclist.rst.tmp"
-
+	cp -f "./source/getting_started.md" "./source/getting_started.md.tmp"
+	sed 's/.md/.html/g; s/.\/docs\/source\//.\//g; s/.\/neural_coder\/extensions\/screenshots/imgs/g; s/.\/docs\/source\/_static/..\/\/_static/g; s/.\/examples/https:\/\/github.com\/intel\/neural-compressor\/tree\/master\/examples/g; s/.md/.html/g; ' "./source/getting_started.md.tmp" > "./source/getting_started.md"
+	rm -f "./source/getting_started.md.tmp"
 
 	# make sure other png can display normal
 	$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

docs/source/README.md

@@ -167,7 +167,7 @@ Intel® Neural Compressor validated 420+ [examples](./examples) for quantization
       <td colspan="3" align="center"><a href="./design.html">Architecture</a></td>
       <td colspan="2" align="center"><a href="https://github.com/intel/neural-compressor/tree/master/examples">Examples</a></td>
       <td colspan="2" align="center"><a href="./bench.html">GUI</a></td>
-      <td colspan="2" align="center"><a href="./api-introduction.html">APIs</a></td>
+      <td colspan="2" align="center"><a href="https://intel.github.io/neural-compressor/api-documentation/apis.html">APIs</a></td>
     </tr>
     <tr>
       <td colspan="5" align="center"><a href="https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-ai-linux/top.html">Intel oneAPI AI Analytics Toolkit</a></td>

docs/source/_static/index.html

@@ -1 +1 @@
-<meta http-equiv="refresh" content="0; URL='README.html'" />
+<meta http-equiv="refresh" content="0; URL='getting_started.html'" />