Documenter.jl
Documenter.jl copied to clipboard
JuliaDocs
A documentation generator for Julia.
It might be useful to have the option to include a `.jl` file in a page and display the code. This would make it easy to have examples in an...
Is there a mechanism to make doctests conditional on Julia version? Printing seems pretty unstable version to version
Currentl,y when we have ````md ```@example a = 2 + 2 ``` ```` the output looks like this  specifically, when executed by documenter, generated code is ```html a =...
Various issues and thoughts that should or could be addressed that are related to the HTML output. Some of these might deserve a separate issue to actually decide the details....
In my `makedocs` I have ``` pages = [ "Introduction" => "index.md", "Contents" => "contents.md", "Dynamical systems" => [ "Dynamical System Definition" => "ds/general.md", "Predefined Dynamical Systems" => "ds/predefined.md", "Numerical...
The new front end for Documenter.jl docs looks really nice! It does not render perfectly on mobile tough https://files.slack.com/files-pri/T68168MUP-FQZN4CSF7/screenshot_20191126-215432.jpg Some text enters the margin, and the top header does not...
Here: https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@ref-link it says: > Note that depending on what the CurrentModule is set to, a docstring @ref may need to be prefixed by the module which defines it. Does...
Headings in admonitions get the same stying as the main body. They should probably be a bit smaller:  X-ref: https://github.com/JuliaLang/julia/pull/36563#discussion_r451386351
Apparently the change to KaTeX is causing some issues in certain browsers. This is in Safari (see the tilde position): This is the same snippet in Chrome: Changing back to...
Following the chat on Slack with @fredrikekre , what happens is that if one produces `DataFrame` in the docs with 1000s of rows, they are not trunctuated:  This may...