Skip to content

Commit ad16dab

Browse files
authored
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
1 parent 4afdfdd commit ad16dab

File tree

3 files changed

+512
-3
lines changed

3 files changed

+512
-3
lines changed

docs/make.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@ using ChainRules
22
using ChainRulesCore
33
using Documenter
44

5+
@show ENV
6+
57
makedocs(
68
modules=[ChainRules, ChainRulesCore],
7-
format=Documenter.HTML(prettyurls=false),
9+
format=Documenter.HTML(prettyurls=false, assets = ["assets/chainrules.css"]),
810
sitename="ChainRules",
911
authors="Jarrett Revels and other contributors",
1012
pages=[

docs/src/assets/chainrules.css

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/* Links */
2+
3+
a {
4+
color: #4595D1;
5+
}
6+
7+
a:hover, a:focus {
8+
color: #194E82;
9+
}
10+
11+
/* Navigation */
12+
13+
nav.toc ul a:hover,
14+
nav.toc ul.internal a:hover {
15+
color: #FFFFFF;
16+
background-color: #4595D1;
17+
}
18+
19+
nav.toc ul .toctext {
20+
color: #FFFFFF;
21+
}
22+
23+
nav.toc {
24+
box-shadow: none;
25+
color: #FFFFFF;
26+
background-color: #194E82;
27+
}
28+
29+
nav.toc li.current > .toctext {
30+
color: #FFFFFF;
31+
background-color: #4595D1;
32+
border-top-width: 0px;
33+
border-bottom-width: 0px;
34+
}
35+
36+
nav.toc ul.internal a {
37+
color: #194E82;
38+
background-color: #FFFFFF;
39+
}
40+
41+
/* Text */
42+
43+
article#docs a.nav-anchor {
44+
color: #194E82;
45+
}
46+
47+
article#docs blockquote {
48+
font-style: italic;
49+
}
50+
51+
/* Terminology Block */
52+
53+
div.admonition.terminology div.admonition-title:before {
54+
content: "Terminology: ";
55+
font-family: inherit;
56+
font-weight: bold;
57+
}
58+
div.admonition.terminology div.admonition-title {
59+
background-color: #FFEC8B;
60+
}
61+
62+
div.admonition.terminology div.admonition-text {
63+
background-color: #FFFEDD;
64+
}
65+
66+
/* Code */
67+
68+
code .hljs-meta {
69+
color: #4595D1;
70+
}
71+
72+
code .hljs-keyword {
73+
color: #194E82;
74+
}
75+
76+
pre, code {
77+
font-family: "Liberation Mono", "Consolas", "DejaVu Sans Mono", "Ubuntu Mono", "andale mono", "lucida console", monospace;
78+
}

0 commit comments

Comments
 (0)