Fix cross refrence

owent · Jul 3, 2020 · 922219c · 922219c
1 parent 133ea69
commit 922219c
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,6 +21,8 @@ docs/output
 docs/sphinx/doxygen
 docs/sphinx/_build
 docs/libcopp.doxyfile
+docs/sphinx/README.rst
+
 
 # IDE & Editors
 /.vscode

diff --git a/README.rst b/README.rst
@@ -98,19 +98,17 @@ Windows
 Install with vcpkg
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-1. clone and setup `vcpkg`_(See more detail on https://github.com/Microsoft/vcpkg)
+1. clone and setup `vcpkg`_ (See more detail on https://github.com/Microsoft/vcpkg)
     .. code-block:: shell
 
         git clone https://github.com/Microsoft/vcpkg.git
         cd vcpkg
-        
-        .\bootstrap-vcpkg.bat
-        ./bootstrap-vcpkg.sh
+        PS> bootstrap-vcpkg.bootstrap
+        Linux:~/$ ./bootstrap-vcpkg.sh
 
 2. install libcopp
     .. code-block:: shell
 
-
         PS> .\vcpkg install libcopp
         Linux:~/$ ./vcpkg install libcopp
 
@@ -251,7 +249,7 @@ There serveral samples to use ``copp::coroutine_context`` 、 ``copp::coroutine_
 10. Let c++20 coroutine work with ``cotask::task``
 11. Using Windows fiber and ``SetUnhandledExceptionFilter`` on Windows with ``cotask::task``
 
-All sample codes can be found on :doc:`./example/index` and `sample <https://github.com/owt5008137/libcopp/tree/v2/sample>`_ .
+All sample codes can be found on :doc:`./docs/sphinx/example/index` and `sample <https://github.com/owt5008137/libcopp/tree/v2/sample>`_ .
 
 NOTICE
 ------------

diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -41,6 +41,14 @@
         LIBCOPP_VERSION_PATCH.group('VERSION')
     )
 
+README_FILE_CONTENT = codecs.open(os.path.join(os.path.dirname(__file__), '..', '..', 'README.rst'), "r", "utf-8").read()
+README_FILE_STREAM = codecs.open(os.path.join(os.path.dirname(__file__), 'README.rst'), "w", "utf-8")
+README_FILE_STREAM.write(
+    re.sub('docs[\\/\\\\]sphinx[\\/\\\\]', '', README_FILE_CONTENT)
+)
+README_FILE_STREAM.close()
+
+
 # -- General configuration ---------------------------------------------------
 # see http://www.sphinx-doc.org/en/master/usage/configuration.html
 

diff --git a/docs/sphinx/example/index.rst b/docs/sphinx/example/index.rst
@@ -1,4 +1,3 @@
-
 EXAMPLES
 ------------
 

diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
@@ -1,5 +1,5 @@
 
-.. include:: ../../README.rst
+.. include:: README.rst
 
 Indices and tables
 ==================
@@ -12,7 +12,7 @@ Indices and tables
     :maxdepth: 2
     :caption: Reference
 
-    `reference <>`_
+    reference/index
 
 .. toctree::
     :maxdepth: 2