https://github.com/gaelforget/hellodocs.jl

Basic example of `Documenter.jl` use
https://github.com/gaelforget/hellodocs.jl

Last synced: 22 days ago
JSON representation

Basic example of `Documenter.jl` use

• Host: GitHub
• URL: https://github.com/gaelforget/hellodocs.jl
• Owner: gaelforget
• License: mit
• Created: 2019-04-11T15:13:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-26T10:04:33.000Z (about 5 years ago)
• Last Synced: 2024-10-10T11:38:12.900Z (about 1 month ago)
• Language: Julia
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# HelloDocs.jl

This example is based on the `Documenter.jl` guide @ 

### 1) generate package

```

(v1.1) pkg> generate HelloDocs

shell> cd HelloDocs

```

### 2) add documentation files

```

julia> using Documenter

julia> using DocumenterTools

julia> DocumenterTools.generate("HelloDocs.jl/docs")

shell> ls HelloDocs/docs/

Project.toml	make.jl		src

shell> ls docs/src

index.md

```

### 3) compile empty doc

```

shell> cd HelloDocs.jl/docs/

julia> makedocs(sitename="HelloDocs.jl Documentation")

```

which created to 

```

$ ls -1 build/*

build/HelloDocs.jl

build/search_index.js

build/assets:

arrow.svg

documenter.css

documenter.js

search.js

build/search:

index.html

```

### 4) add docstring, etc examples and compile `make.jl`

Docstrings were added in `src/HelloDocs.jl` and refs in `docs/src/index.md` before compiling `julia --color=yes make.jl` from within `docs/` in shell. Compilation then added two docstrings (`GreetUser` and `greet`) to `docs/build/index.html` and issued a warning as expected for `GreetYou`.