Move the docs over from ChainRules #115

oxinabox · 2020-01-22T18:43:56Z

There are no docstrings in ChainRules.jl, its just the rules.
Most often when we need to change the docs it is because of changes in ChainRulesCore

They need to automatically build in response to docstrings changing in this package.

* Add Documentation setup with Documenter This adds no actual documentation, only the infrastructure needed to set up and deploy documentation. * Remove testing on 0.7, add 1.1 In the REQUIRE file, the package declares itself to be compatible only with Julia 1.0 or higher, but 0.7 was still listed in CI. This removes 0.7 and adds 1.1. It also updates the coverage setup. * Add a Project.toml file These are indispensible for local development, and will soon be required anyway (for some definition of "soon"). * Add missing dependency on ForwardDiff to REQUIRE

This is mostly copying what's in comments in the code into actual doc files along with the existing docstrings. I've also added a couple of basic docstrings.

…o remove dev notes until we can restructure them into an advanced tips section

…ChainRulesCore (#93) * =Remove uses of add and mul from tests because they have been removed from ChainRulesCore * remove ref to Cassette. Slightly improve talk of ChainRulesCore * Update getting_started.md * Update Project.toml

* PR preview docs * add link to remind to clean up this code once less evil way is possible * Update docs/make.jl * fix typo * . * . * fix docs badge links * remove debug println * =highlight readme

* 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

* Add Logo * Add Logo to readme * fix max size of logo in readme * fix max size of logo in readme * fix max size of logo in readme * fix width in readme

* Add difference between `Zero` and `DoesNotExist` to FAQ * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> Co-authored-by: Nick Robinson <npr251@gmail.com>

* Doc updates for ChainRulesCore 0.5 * Apply suggestions from code review Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update index.md * Apply suggestions from code review Co-Authored-By: willtebbutt <wt0881@my.bristol.ac.uk> Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs/src/index.md Co-authored-by: Nick Robinson <npr251@gmail.com> Co-authored-by: willtebbutt <wt0881@my.bristol.ac.uk>

* Remove TODO sections * Move info about chainrules vs chainrulescore to FAQ

* Break up giant single page of docs * Update docs/src/writing_good_rules.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs make.jl Co-authored-by: Nick Robinson <npr251@gmail.com>

* Remove `store!`, `accumulate`, `accumulate!` * Remove `test_accumulate` functions

docs/make.jl

Co-Authored-By: Nick Robinson <npr251@gmail.com>

oxinabox · 2020-01-22T19:19:44Z

Preview Docs: http://www.juliadiff.org/ChainRulesCore.jl/preview-PR115/
(Demonstrating that deploy does indeed still work, so I setup the docs deployment right)

oxinabox · 2020-01-22T19:22:58Z

All the titles still stay ChainRules, but I am OK with that.
That is the project name.

oxinabox · 2020-01-22T19:24:51Z

The edit on github button 404's but that is ok because: it is point at master branch which doesn't have these files yet.
https://github.com/JuliaDiff/ChainRulesCore.jl/blob/master/docs/src/index.md

oxinabox · 2020-01-22T19:25:37Z

the [source] links in the API page seem to work

nickrobinson251 · 2020-01-22T19:27:43Z

Update URL in docs badge on Readme and Index page?

oxinabox · 2020-01-22T19:33:21Z

Updated Readme.
One in Index is correct. ChainRules.jl is for AD implementors.

Intro pragraph could use update to refer to both packages, but that is not for this PR.

docs/make.jl

docs/src/FAQ.md

mattBrzezinski · 2020-01-22T19:32:54Z

docs/src/FAQ.md

+     - `ΔΩ` is thus a seed for the pullback.
+     - `∂Ω` is thus the output of a pushforward.
+
+


Suggested change

docs/src/assets/make_logo.jl

mattBrzezinski · 2020-01-22T19:48:03Z

docs/src/index.md

+That pullback function is used like:
+`∂self, ∂args... = pullback(Δy)`
+
+


Suggested change

docs/src/index.md

Co-Authored-By: Matt.jl <matt.brzezinski@invenia.ca>

ararslan and others added 22 commits January 22, 2020 18:37

Add basic documentation

d64774b

This is mostly copying what's in comments in the code into actual doc files along with the existing docstrings. I've also added a couple of basic docstrings.

Add basic docs for Rule

40f7869

rework docs section to prep for planned content + API docstrings. als…

f972084

…o remove dev notes until we can restructure them into an advanced tips section

fix typo

f38a72f

Fix documentation to use ChainRulesCore

57fdc0e

Add details about dependencies

d04fb53

Remove ChainRules as it has no user-facing names

82557ea

Correct package name NaNMath

6b18cac

PR preview docs (#105)

e4ff2f1

* PR preview docs * add link to remind to clean up this code once less evil way is possible * Update docs/make.jl * fix typo * . * . * fix docs badge links * remove debug println * =highlight readme

Add Logo (#113)

8e8b036

* Add Logo * Add Logo to readme * fix max size of logo in readme * fix max size of logo in readme * fix max size of logo in readme * fix width in readme

Fix TeX in docs

987cc9f

Fix a few spelling mistakes and formatting issues

129fd55

Remove Wirtinger

40c0713

Remove TODO sections in docs (#150)

f9dc97f

* Remove TODO sections * Move info about chainrules vs chainrulescore to FAQ

Break up giant single page of docs (#158)

191e8c2

* Break up giant single page of docs * Update docs/src/writing_good_rules.md Co-Authored-By: Nick Robinson <npr251@gmail.com> * Update docs make.jl Co-authored-by: Nick Robinson <npr251@gmail.com>

Remove store!, accumulate, accumulate! (#161)

deeca7b

* Remove `store!`, `accumulate`, `accumulate!` * Remove `test_accumulate` functions

Make docs build with travis CI

e0e424f

nickrobinson251 reviewed Jan 22, 2020

View reviewed changes

docs/make.jl Outdated Show resolved Hide resolved

oxinabox and others added 2 commits January 22, 2020 19:07

Add Manifest

342c092

Update docs/make.jl

ffa1f16

Co-Authored-By: Nick Robinson <npr251@gmail.com>

oxinabox mentioned this pull request Jan 22, 2020

Move docs to ChainRulesCore JuliaDiff/ChainRules.jl#163

Merged

mattBrzezinski self-assigned this Jan 22, 2020

update link in readme

9f33fc2

nickrobinson251 approved these changes Jan 22, 2020

View reviewed changes

mattBrzezinski reviewed Jan 22, 2020

View reviewed changes

Apply suggestions from code review

b0ef3c2

Co-Authored-By: Matt.jl <matt.brzezinski@invenia.ca>

mattBrzezinski approved these changes Jan 22, 2020

View reviewed changes

oxinabox merged commit b0b8dbf into master Jan 22, 2020

nickrobinson251 deleted the ox/movedoctsD2 branch January 22, 2020 21:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move the docs over from ChainRules #115

Move the docs over from ChainRules #115

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

nickrobinson251 commented Jan 22, 2020

oxinabox commented Jan 22, 2020

mattBrzezinski Jan 22, 2020

mattBrzezinski Jan 22, 2020

		- `ΔΩ` is thus a seed for the pullback.
		- `∂Ω` is thus the output of a pushforward.

		That pullback function is used like:
		`∂self, ∂args... = pullback(Δy)`

Move the docs over from ChainRules #115

Move the docs over from ChainRules #115

Conversation

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

oxinabox commented Jan 22, 2020

nickrobinson251 commented Jan 22, 2020

oxinabox commented Jan 22, 2020

mattBrzezinski Jan 22, 2020

Choose a reason for hiding this comment

mattBrzezinski Jan 22, 2020

Choose a reason for hiding this comment