introdocs + demo + instructions on writing good rules (#103)

* start writing intro * First full draft * Update docs/src/index.md Co-Authored-By: Matt Brzezinski <matt.brzezinski@invenia.ca> * Update docs/src/index.md Co-Authored-By: Matt Brzezinski <matt.brzezinski@invenia.ca> * Update docs/src/index.md Co-Authored-By: Matt Brzezinski <matt.brzezinski@invenia.ca> * Apply suggestions from code review Co-Authored-By: Matt Brzezinski <matt.brzezinski@invenia.ca> * add FAQ * Update docs/src/index.md Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Update docs/src/index.md Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Update docs/src/index.md Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Update docs/src/index.md Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Apply suggestions from code review Co-Authored-By: Kristoffer Carlsson <kristoffer.carlsson@chalmers.se> * Update docs/src/index.md Co-Authored-By: Kristoffer Carlsson <kristoffer.carlsson@chalmers.se> * Make terminology blocks render. Also style the TOC to match * move explaintikn of returning value to FAQ * Reformat docs homepage * Make sidebar blue * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Fredrik Bagge Carlson <baggepinnen@gmail.com> * show all ENV during docs building * Update docs/src/index.md * Update docs/src/assets/chainrules.css * Update docs/src/index.md Co-Authored-By: Seth Axen <seth.axen@gmail.com> * Update docs/src/index.md Co-Authored-By: Mateusz Baran <mateuszbaran89@gmail.com> * Update docs/src/index.md Co-Authored-By: Glenn Moynihan <glennmoy@gmail.com> * Update docs/src/index.md Co-Authored-By: Glenn Moynihan <glennmoy@gmail.com> * inherit font for admonition title:before * fix CSS tabs * Update docs/src/index.md Co-Authored-By: Seth Axen <seth.axen@gmail.com> * reorder * Update docs/src/index.md Co-Authored-By: Seth Axen <seth.axen@gmail.com> * Apply suggestions from code review Co-Authored-By: Seth Axen <seth.axen@gmail.com> Co-Authored-By: Mateusz Baran <mateuszbaran89@gmail.com> * fix ffrule repetition * improve * add about gradient wrt kwargs * explain what differentials are * improve * wip * fix citation Co-Authored-By: Seth Axen <seth.axen@gmail.com> * Update docs/src/assets/chainrules.css Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * use latex for overbar Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Update docs/src/index.md Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Update docs/src/index.md Co-Authored-By: simeonschaub <simeondavidschaub99@gmail.com> * Work on defination of pushforward and pullback * fixmath * brackets * Hide comment * Describe things a few more times * add more on dotted and barred forms * fix note * not more
JuliaDiff · Sep 25, 2019 · ad16dab · ad16dab
1 parent 4afdfdd
commit ad16dab
Show file tree

Hide file tree

Showing 3 changed files with 512 additions and 3 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,9 +2,11 @@ using ChainRules
 using ChainRulesCore
 using Documenter
 
+@show ENV
+
 makedocs(
     modules=[ChainRules, ChainRulesCore],
-    format=Documenter.HTML(prettyurls=false),
+    format=Documenter.HTML(prettyurls=false, assets = ["assets/chainrules.css"]),
     sitename="ChainRules",
     authors="Jarrett Revels and other contributors",
     pages=[

diff --git a/docs/src/assets/chainrules.css b/docs/src/assets/chainrules.css
@@ -0,0 +1,78 @@
+/* Links */
+
+a {
+  color: #4595D1;
+}
+
+a:hover, a:focus {
+  color: #194E82;
+}
+
+/* Navigation */
+
+nav.toc ul a:hover,
+nav.toc ul.internal a:hover {
+  color: #FFFFFF;
+  background-color: #4595D1;
+}
+
+nav.toc ul .toctext {
+  color: #FFFFFF;
+}
+
+nav.toc {
+  box-shadow: none;
+  color: #FFFFFF;
+  background-color: #194E82;
+}
+
+nav.toc li.current > .toctext {
+  color: #FFFFFF;
+  background-color: #4595D1;
+  border-top-width: 0px;
+  border-bottom-width: 0px;
+}
+
+nav.toc ul.internal a {
+  color: #194E82;
+  background-color: #FFFFFF;
+}
+
+/* Text */
+
+article#docs a.nav-anchor {
+  color: #194E82;
+}
+
+article#docs blockquote {
+  font-style: italic;
+}
+
+/* Terminology Block */
+
+div.admonition.terminology div.admonition-title:before {
+  content: "Terminology: ";
+  font-family: inherit;
+  font-weight: bold;
+}
+div.admonition.terminology div.admonition-title {
+  background-color: #FFEC8B;
+}
+
+div.admonition.terminology div.admonition-text {
+  background-color: #FFFEDD;
+}
+
+/* Code */
+
+code .hljs-meta {
+  color: #4595D1;
+}
+
+code .hljs-keyword {
+  color: #194E82;
+}
+
+pre, code {
+  font-family: "Liberation Mono", "Consolas", "DejaVu Sans Mono", "Ubuntu Mono", "andale mono", "lucida console", monospace;
+}