Skip to content

Commit

Permalink
get rid of all the 'index' links on the home of the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Issa Hanou committed Nov 14, 2024
1 parent fd0a9d4 commit d453a3f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ end

build()

# NOTE: tutorials should be added manually on the homepage (src/index.md)

makedocs(
modules=[HerbConstraints, HerbSearch, HerbGrammar, HerbSpecification, HerbInterpret, HerbCore],
Expand Down
17 changes: 14 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ CurrentModule=Herb

## Why Herb.jl?

When writing research software we almost always investigate highly specific properties or algorithms of our domain, leading to us building the tools from scratch over and over again. The very same holds for the field of program synthesis: Tools are hard to run, benchmarks are hard to get and prepare, and its hard to adapt our existing code to a novel idea.
When writing research software we almost always investigate highly specific properties or algorithms of our domain, leading to us building the tools from scratch over and over again. The very same holds for the field of program synthesis: Tools are hard to run, benchmarks are hard to get and prepare, and it is hard to adapt our existing code to a novel idea.

Herb.jl will take care of this for you and helps you defining, solving and extending your program synthesis problems.
Herb.jl will take care of this for you and helps you in defining, solving and extending your program synthesis problems.

Herb.jl provides...
- a unified and universal framework for program synthesis
Expand Down Expand Up @@ -46,6 +46,17 @@ Pages = ["install.md", "get_started.md", "concepts.md"]
```

## Advanced content

```@contents
Pages = [p * "/index.md" for p in readdir(joinpath(dirname(@__FILE__), "..", "src")) if occursin("Herb", p)]
Depth = 1
```

## Tutorials
To familiarize yourself with Herb, we have created several tutorials:
- [A more verbose getting started with Herb.jl](tutorials/getting_started_with_herb.md)
- [Defining Grammars in Herb.jl](tutorials/defining_grammars.md)
- [Advanced Search Procedures](tutorials/advanced_search.md)
- [Top Down Iterator](tutorials/TopDown.md)
- [Getting started with Constraints](tutorials/getting_started_with_constraints.md)
- [Working with custom interpreters](tutorials/working_with_interpreters.md)
- [Abstract Syntax Trees](tutorials/abstract_syntax_trees.md)

0 comments on commit d453a3f

Please sign in to comment.