Documenter.jl

Documenter.jl copied to clipboard

API for plugin assets

19

First time melding here. Hope i did not break anything.

LazyScholar

In my package's documentation, I have a page `public.md` with the following contents: ````md # Public API ```@autodocs Modules = [MyPackage] Public = true Private = false ``` ```` And...

DilumAluthge

If `strict=true` and a `@repl` block throws an exception, the build should fail

5

Before this PR: | `strict` | Block that throws an exception | Build result | | -------- | ------------------------------ | ----------------------- | | `true` | `@example` | :x: fail |...

DilumAluthge

This allows regex - substitution pairs to be passed as doctest filters, giving more control over filtering. For example, the following filter can be used to only retain the first...

mortenpi

Semicolon after jldoctest changes help output to script-mode

3

Example: ```julia """ ```jldoctest julia> 1+1 2 ``` """ function testfun1() end """ ```jldoctest; julia> 1+1 2 ``` """ function testfun2() end """ ```jldoctest aa; julia> 1+1 2 ``` """...

DrChainsaw

Headings not always rendered

6

I have some situations where a `### Heading` is consistenly not rendered (locally and on github pages), although all markdown rules seem to be followed  I consequently get these...

milankl

Suppress errors for unexported functions

8

Is there a way to suppress errors about missing documentation for unexported functions?

lelogrott

Cache search objects in localStorage for faster search loading

2

I'm hoping to speed up the displaying of search results after a page reload. It's nice and fast when updating the search box, but the building of the search dictionaries...

IanButterworth

Use Stork as the search backend in HTML sites

6

Hello, at the moment, reloading the search page or reloading a page built with Documenter leads to VERY noticeable lag on the first search. Since it's kind of unusual to...

Seelengrab

@autodocs not including macro or struct

2

Hi, I'm a new user so apologies if I missed something in documentation--I'm wondering how to get Documenter to document a struct & macro that are exported? e.g. https://github.com/tbenst/Thunks.jl/blob/8f13f468c7b2b15b8cca4a33cb42df20cc18c20d/src/Thunks.jl#L120 exports...

tbenst