René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Documentation issues","articleBody":"I'm building mpl documentation and wanted to notice these issues:\n\n1) On Windows `os.symlink()` requires administrative privileges:\n\n``` pytb\nTraceback (most recent call last):\n  File \"make.py\", line 172, in \u003cmodule\u003e\n    os.symlink(target, link)\nOSError: symbolic link privilege not held\n```\n\nI'll propose this workaround:\n\n``` diff\n--- a/doc/make.py\n+++ b/doc/make.py\n\n@@ -168,9 +178,9 @@ for link, target in required_symlinks:\n             raise RuntimeError(\"doc/{0} should be a directory or symlink -- it\"\n                                \" isn't\".format(link))\n     if not os.path.exists(link):\n-        if hasattr(os, 'symlink'):\n+        try:\n             os.symlink(target, link)\n-        else:\n+        except OSError:\n             symlink_warnings.append('files copied to {0}'.format(link))\n             shutil.copytree(os.path.join(link, '..', target), link)\n```\n\n---\n\n2) Documentation's readme says that besides installed matplotlib it is also required matplotlib to be build from source. This seemed unfortunate and I made this workaround to avoid building:\n\n``` diff\n--- a/doc/make.py\n+++ b/doc/make.py\n\n@@ -7,6 +7,7 @@ import shutil\n import sys\n import re\n import argparse\n+import matplotlib\n\n def copy_if_out_of_date(original, derived):\n     if (not os.path.exists(derived) or\n@@ -38,7 +39,11 @@ def linkcheck():\n\n def html(buildername='html'):\n     check_build()\n-    copy_if_out_of_date('../lib/matplotlib/mpl-data/matplotlibrc', '_static/matplotlibrc')\n+    rc = '../lib/matplotlib/mpl-data/matplotlibrc'\n+    active_rc = matplotlib.matplotlib_fname()\n+    if not os.path.exists(rc) and os.path.exists(active_rc):\n+        rc = active_rc\n+    copy_if_out_of_date(rc, '_static/matplotlibrc')\n     if small_docs:\n         options = \"-D plot_formats=png:80\"\n```\n\n---\n\n3) On finishing, I got this error:\n\n```\n...\ngenerating indices... genindex py-modindex\nwriting additional pages... index citing gallery\nWarning, treated as error:\nWARNING: a Unicode error occurred when rendering the page gallery. Please make sure all config values that contain non-ASCII content are Unicode strings.\n```\n\nAfter quite digging around, I figured that `gen_gallery.py` is responsible for this error - generated `gallery.html` ended encoded in my local code page instead UTF-8. I converted gallery file to UTF-8 and disabled writing to this file in `gen_gallery.py` to be able to make the docs.\n\nI'm not comfortable with trying to fix this, considering both Python versions and OSs, so just to report.\n\n---\n\n_matplotlib-2.0.0b1 on 64-bit Python 3.5.1 on Windows 10_\n","author":{"url":"https://github.com/klonuo","@type":"Person","name":"klonuo"},"datePublished":"2016-06-02T02:46:20.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/6527/matplotlib/issues/6527"}