PyDoc: Remove hack to rename main doc from 'contents' to 'index'
authorAaron Carlisle <carlisle.b3d@gmail.com>
Mon, 13 Aug 2018 23:07:50 +0000 (19:07 -0400)
committerAaron Carlisle <carlisle.b3d@gmail.com>
Tue, 14 Aug 2018 00:51:33 +0000 (20:51 -0400)
GNUmakefile
doc/python_api/sphinx_doc_gen.py
doc/python_api/sphinx_doc_gen.sh
doc/python_api/sphinx_doc_update.py

index c1be177..277ee17 100644 (file)
@@ -455,7 +455,7 @@ doc_py: .FORCE
        "$(BUILD_DIR)/bin/blender" --background -noaudio --factory-startup \
                --python doc/python_api/sphinx_doc_gen.py
        cd doc/python_api ; sphinx-build -b html sphinx-in sphinx-out
-       @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/contents.html'"
+       @echo "docs written into: '$(BLENDER_DIR)/doc/python_api/sphinx-out/index.html'"
 
 doc_doxy: .FORCE
        cd doc/doxygen; doxygen Doxyfile
index 2195f49..b542eb4 100644 (file)
@@ -1679,7 +1679,7 @@ def write_rst_contents(basepath):
     '''
     Write the rst file of the main page, needed for sphinx (index.html)
     '''
-    filepath = os.path.join(basepath, "contents.rst")
+    filepath = os.path.join(basepath, "index.rst")
     file = open(filepath, "w", encoding="utf-8")
     fw = file.write
 
@@ -1692,7 +1692,6 @@ def write_rst_contents(basepath):
     # fw("`A PDF version of this document is also available <%s>`_\n" % BLENDER_PDF_FILENAME)
     fw("This site can be downloaded for offline use `Download the full Documentation (zipped HTML files) <%s>`_\n" %
        BLENDER_ZIP_FILENAME)
-
     fw("\n")
 
     if not EXCLUDE_INFO_DOCS:
@@ -2109,8 +2108,6 @@ def main():
             shutil.copytree(SPHINX_OUT,
                             REFERENCE_PATH,
                             ignore=shutil.ignore_patterns(*ignores))
-            shutil.copy(os.path.join(REFERENCE_PATH, "contents.html"),
-                        os.path.join(REFERENCE_PATH, "index.html"))
 
             # zip REFERENCE_PATH
             basename = os.path.join(ARGS.output_dir, REFERENCE_NAME)
index b3bdd38..0c1f531 100755 (executable)
@@ -122,7 +122,6 @@ fi
 
 if $DO_UPLOAD ; then
 
-       cp $SPHINX_WORKDIR/sphinx-out/contents.html $SPHINX_WORKDIR/sphinx-out/index.html
        ssh $SSH_USER@blender.org 'rm -rf '$SSH_UPLOAD_FULL'/*'
        rsync --progress -ave "ssh -p 22" $SPHINX_WORKDIR/sphinx-out/* $SSH_HOST:$SSH_UPLOAD_FULL/
 
@@ -161,5 +160,5 @@ fi
 
 echo ""
 echo "Finished! view the docs from: "
-if $DO_OUT_HTML ; then echo "  html:" $SPHINX_WORKDIR/sphinx-out/contents.html ; fi
+if $DO_OUT_HTML ; then echo "  html:" $SPHINX_WORKDIR/sphinx-out/index.html ; fi
 if $DO_OUT_PDF ; then  echo "   pdf:" $SPHINX_WORKDIR/sphinx-out/blender_python_reference_$BLENDER_VERSION.pdf ; fi
index af44137..7021513 100755 (executable)
@@ -163,7 +163,6 @@ def main():
     os.rename(zip_path, os.path.join(api_dir, "%s.zip" % zip_name))
 
     # VII) Create symlinks and html redirects.
-    os.symlink("./contents.html", os.path.join(api_dir, "index.html"))
     if is_release:
         symlink = os.path.join(args.mirror_dir, "current")
         os.remove(symlink)