Remove README from docs (#503)

* Remove readme from docs * Remove unused package * Remove reference to readme
Lightning-Universe · Jan 11, 2021 · c43622e · c43622e
1 parent 1a45b50
commit c43622e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 11 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,7 +17,6 @@
 import glob
 import inspect
 import os
-import re
 import shutil
 import sys
 
@@ -53,15 +52,15 @@
 
 # -- Project documents -------------------------------------------------------
 # export the READme
-with open(os.path.join(PATH_ROOT, 'README.md'), 'r') as fp:
-    readme = fp.read()
-# TODO: temp fix removing SVG badges and GIF, because PDF cannot show them
-readme = re.sub(r'(\[!\[.*\))', '', readme)
-readme = re.sub(r'(!\[.*.gif\))', '', readme)
-for dir_name in (os.path.basename(p) for p in glob.glob(os.path.join(PATH_ROOT, '*')) if os.path.isdir(p)):
-    readme = readme.replace('](%s/' % dir_name, '](%s/%s/' % (PATH_ROOT, dir_name))
-with open('readme.md', 'w') as fp:
-    fp.write(readme)
+# with open(os.path.join(PATH_ROOT, 'README.md'), 'r') as fp:
+#     readme = fp.read()
+# # TODO: temp fix removing SVG badges and GIF, because PDF cannot show them
+# readme = re.sub(r'(\[!\[.*\))', '', readme)
+# readme = re.sub(r'(!\[.*.gif\))', '', readme)
+# for dir_name in (os.path.basename(p) for p in glob.glob(os.path.join(PATH_ROOT, '*')) if os.path.isdir(p)):
+#     readme = readme.replace('](%s/' % dir_name, '](%s/%s/' % (PATH_ROOT, dir_name))
+# with open('readme.md', 'w') as fp:
+#     fp.write(readme)
 
 # copy all documents from GH templates like contribution guide
 for md in glob.glob(os.path.join(PATH_ROOT, '.github', '*.md')):

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -118,7 +118,6 @@ Indices and tables
 .. toctree::
    :hidden:
 
-   readme
    api/pl_bolts.callbacks
    api/pl_bolts.datamodules
    api/pl_bolts.datasets