Merge pull request #27 from openml/dev

Support for building documentation in markdown

Author: jbrea

.gitignore

@@ -4,7 +4,6 @@ Manifest.toml
 #*
 .DS_Store
 sandbox/
-/docs/build/
 /docs/site/
 /docs/Manifest.toml
 .vscode

docs/Project.toml

@@ -3,6 +3,7 @@ DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 OpenML = "8b6db2d4-7670-4922-a472-f9537c81ab66"
 ScientificTypes = "321657f4-b219-11e9-178b-2701a2544e81"
+DocumenterMarkdown
 
 [compat]
 Documenter = "~0.26"

docs/README.md

@@ -0,0 +1,11 @@
+Contains both the original `Documenter.jl` documentation and the same documentation rendered as markdown to include in the harmonized OpenML docs.
+
+Generating the markdown is done as follows:
+
+* Install [DocumenterMarkDown](https://documentermarkdown.juliadocs.org/dev/).
+    * Note: currently this only works with version 0.27 of Documenter.jl
+    * In Julia, open the package manager (type ']') and run `add [email protected]` and `add DocumenterMarkdown`.
+* Run `julia make-md.jl` in the `docs` folder to generate the markdown filew
+    * These appear in the `build` folder
+* Run `mkdocs serve` in the root folder to build the markdown docs.
+

docs/build/assets/Documenter.css

@@ -0,0 +1,18 @@
+div.wy-menu-vertical ul.current li.toctree-l3 a {
+  font-weight: bold;
+}
+
+a.documenter-source {
+  float: right;
+}
+
+.documenter-methodtable pre {
+    margin-left: 0;
+    margin-right: 0;
+    margin-top: 0;
+    padding: 0;
+}
+
+.documenter-methodtable pre.documenter-inline {
+    display: inline;
+}

docs/build/assets/mathjaxhelper.js

@@ -0,0 +1,25 @@
+MathJax.Hub.Config({
+  "tex2jax": {
+    inlineMath: [['$','$'], ['\\(','\\)']],
+    processEscapes: true
+  }
+});
+MathJax.Hub.Config({
+  config: ["MMLorHTML.js"],
+  jax: [
+    "input/TeX",
+    "output/HTML-CSS",
+    "output/NativeMML"
+  ],
+  extensions: [
+    "MathMenu.js",
+    "MathZoom.js",
+    "TeX/AMSmath.js",
+    "TeX/AMSsymbols.js",
+    "TeX/autobold.js",
+    "TeX/autoload-all.js"
+  ]
+});
+MathJax.Hub.Config({
+  TeX: { equationNumbers: { autoNumber: "AMS" } }
+});