Merge pull request #4700 from martinbaker/mydoc

Add Documentation for Elaborator Reflection

docs/_static/theme_overrides.css

@@ -0,0 +1,13 @@
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}

docs/conf.py

@@ -51,7 +51,7 @@
 
 # General information about the project.
 project = u'Idris'
-copyright = u'2017, The Idris Community'
+copyright = u'2017-2019, The Idris Community'
 author = u'The Idris Community'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -151,6 +151,12 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_context = {
+    'css_files': [
+        '_static/theme_overrides.css',  # override wide tables in RTD theme
+        ],
+     }
+
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.

docs/image/README.md

@@ -0,0 +1,16 @@
+Many of the images in this directory have two files with the same name but a different extension:
+
+* The SVG file, being vector graphics, is best for drawing and modifying.
+* The PNG file, being raster graphics, gives more consistent rendering.
+
+The image has therefore been generated as an SVG file and then exported to the PNG file.
+
+So, if you need to modify an image, I suggest the following sequence:
+
+* Edit the SVG file using a suitable editor (I use Inkscape).
+* Export the changes to the PNG file, overwriting the old version.
+* upload both files.
+
+Note, when exporting in Inkscape:
+* Select everything first, this stops an enormous boundary being exported.
+* After selecting the file to export to and clicking OK, don't forget to click on export button as well.