Skip to content

Commit

Permalink
Change docs settings
Browse files Browse the repository at this point in the history
  • Loading branch information
AP6YC committed Oct 14, 2020
1 parent e8edfdf commit b4deb36
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ using Documenter, AdaptiveResonance
makedocs(;
modules=[AdaptiveResonance],
format=Documenter.HTML(),
pages=[
"Home" => "index.md",
],
# pages=[
# "Home" => "index.md",
# ],
repo="https://github.com/AP6YC/AdaptiveResonance.jl/blob/{commit}{path}#L{line}",
sitename="AdaptiveResonance.jl",
authors="Sasha Petrenko",
Expand Down
12 changes: 5 additions & 7 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# AdaptiveResonance.jl

```@index
```

The [Package Guide](@ref) provides a tutorial explaining how to get started using Documenter.

Some examples of packages using Documenter can be found on the [Examples](@ref) page.
Expand All @@ -20,16 +17,14 @@ Pages = [
]
Depth = 1
```

This is how you use the module manually.
<!-- This is how you use the module manually. -->

## Library Outline

```@contents
Pages = ["lib/public.md", "lib/internals.md"]
```

This is how you develop the library.
<!-- This is how you develop the library. -->

### [Index](@id main-index)

Expand All @@ -40,3 +35,6 @@ Pages = ["lib/public.md"]
```@autodocs
Modules = [AdaptiveResonance]
```

<!-- ```@index
``` -->
8 changes: 6 additions & 2 deletions docs/src/man/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ Here are some helpful examples of the usage of the module.

## Example 1:

asdf
```julia
art = DDVFA()
```

## Example 2:

asdf
```julia
art = SFAM()
```

0 comments on commit b4deb36

Please sign in to comment.