Documenter.jl
Documenter.jl copied to clipboard
JuliaDocs
A documentation generator for Julia.
In my experience, many powerful julia packages are limited by the fact that their documentation is not up to date or is not clear. Users will typically get clarification in...
When we construct the HTTPS URLs for deployment, we usually include the password (e.g. `GITHUB_TOKEN`) in the URL, which ends up in some Git commands etc., and could potentially be...
Consider the following (contrived) example: ```julia module Tmp "generic method" function g(::Any, ::Any) end "extra doc for specialized method" g(::Real) end # module ``` We define a single function and...
Consider the following reduced example: ```julia module Tmp export f "method for Real" function f(::Vector{
Awesome work on Documenter.jl, Using docker could be difficult due to root, so could it be possible to add Podman platform as an alternative to docker in LatexWriter.jl: compile_tex(doc::Documents.Document, settings::LaTeX,...
A great feature of `@autodocs` is `Filter`. So, I can do for example: ``` ```@autodocs Modules = [CellArrays] Order = [:type] Filter = t -> typeof(t) !== CellArray ``` It...
It would be nice to be able to run `doctest()` on: 1. A module without a `*/docs/src/` directory. Right now it throws an error. 2. A separate function, in order...
We still use the system `git` on Mac to work around the linking problems. Setting `GIT_TEMPLATE_DIR` (which Git.jl does) is necessary to make sure that our `git init` and `git...
How do I document/test examples that involve `Distributed`? Is it somehow possible to deactivate the sandboxing, such that `@everywhere` works as expected? ### Example Consider the following `src/index.md`: `````` ```jldoctest...
We don't allow e.g. at-example blocks in docstrings (because they have to be evaluated), but this might not be obvious to the user. We could print a warning (or even...