DocumentationGenerator.jl
DocumentationGenerator.jl copied to clipboard
JuliaDocs
We should create and publish a standard Docker-based environment in which the users can execute their documentation builds. This would hopefully mean that any issues that DocumentationGenerator encounters could easily...
DocumentationGenerator can generate multiple versions of the docs for a given package version: fallback readme + API, documenter docs, just the HTML readme. Right now, that's all opaquely handled by...
``` ┌ Error: Failed to evaluate specified make.jl-file. │ exception = │ failed process: Process(`/usr/local/julia/bin/julia --project=/juliateam/.julia/packages/Sunny/8q9dF/docs --compiled-modules=no --pkgimages=no -O0 /juliateam/.julia/packages/DocumentationGenerator/r5I78/src/rundocumenter.jl /juliateam/.julia/packages/Sunny/8q9dF/ /juliateam/.julia/packages/Sunny/8q9dF/docs/make.jl`, ProcessSignaled(9)) [0] │ └ @ DocumentationGenerator ~/.julia/packages/DocumentationGenerator/r5I78/src/builders.jl:224 [...
1. Uses [Org.jl](https://github.com/tecosaur/Org.jl) to render fallback docs from `README.org` files a bit better. 2. Readmes without extensions will be rendered as `` text. 3. Readmes that have an unknown extension...
This can cause problems when running in a long-running environment (as opposed to CI; #202). We can copy the package source out to a temporary directory first.
I'm not actually that knowledgeable about [RegistryInstances](https://github.com/GunnarFarneback/RegistryInstances.jl), but I think (hope) that it would allow us to get rid of all the custom registry parsing we do here: https://github.com/JuliaDocs/DocumentationGenerator.jl/blob/e553973f0387f3136a1066b67d6020ce27b462d9/src/utils/pkgtools.jl#L312-L354 And...
Right now, this is what I had to do to get the docs for the latest HDF5.jl package to build locally: ```julia using DocumentationGenerator packages = DocumentationGenerator.installable_on_version(joinpath(homedir(), ".julia", "registries", "General"),...
This makes `DocumentationGenerator.build_documentation` fail with ``` ERROR: type NamedTuple has no field server_type Stacktrace: [1] getproperty @ ./Base.jl:38 [inlined] [2] start_builder(package::NamedTuple{(:name, :url, :uuid, :path, :versions), Tuple{String, String, String, String, Vector{VersionNumber}}},...
It doesn't look like `package.versions` is guaranteed to be sorted, and I presume the intent here is to pick the latest version? https://github.com/JuliaDocs/DocumentationGenerator.jl/blob/80b8c217a193a283c1617157c6a6e343fb8ecb79/src/DocumentationGenerator.jl#L80
[`try_use_package`](https://github.com/JuliaDocs/DocumentationGenerator.jl/blob/80b8c217a193a283c1617157c6a6e343fb8ecb79/src/DocumentationGenerator.jl#L33-L44) loads the package in the current environment. But this can cause problems if there are conflicts between the dependencies of the two. This is the case for [MarkdownAST](https://juliahub.com/ui/Code/docs/MarkdownAST/6YkiC/0.1.1.log), which...