search

QuantEcon / SimpleDifferentialOperators.jl

Library for simple upwind finite differences
MIT License
12 stars 2 forks source link

Expand out the table of contents in the help #178

Closed jlperla closed 5 years ago

jlperla commented 5 years ago

In the table of contents of the Usage section in https://quantecon.github.io/SimpleDifferentialOperators.jl/stable/ is there any way for us to have it list out the different experiments so it is easier to jump to them? e.g. something like

- Installation
- Usage
  - Solving HJBE with constant drifts
  - Solving HJBE with absorbing barrier conditions
   ...
- Notebooks
- API

If in order to do that, you need to kick things up a level to have the TOC pick it up, then maybe try changing the structure to something like

# [SimpleDifferentialOperators.jl](https://github.com/QuantEcon/SimpleDifferentialOperators.jl/)
# Installation and Derivations

To install, run
```julia
] add SimpleDifferentialOperators

Note that this requires Julia 1.1 or later.

See the documentation for the detailed derivations.

Solving HJBE with constant drifts

Consider solving for v from the following equation by the Hamilton-Jacobi-Bellman equation (HJBE):

jlperla commented 5 years ago

@arnavs , are you able to take a look at the table of contents structure when you get a chance? I think you setup the original Documenter structure.

arnavs commented 5 years ago

No problem. Yeah, I set it up- I think this is definitely possible by tweaking a setting for TOC depth. Will take a look.

arnavs commented 5 years ago

Alright @jlperla take a look at the dev docs (you'll have to go to the dropdown in the main docs.) Sorry for delay; took some slight detours to patch up other issues here and there with things like Registrator.

I did the grouping in the "canonical" way, e.g. the one at the bottom here.

arnavs commented 5 years ago

Closing per slack.