Pollen.jl icon indicating copy to clipboard operation
Pollen.jl copied to clipboard

Comparison with Documenter.jl?

Open Datseris opened this issue 2 years ago • 2 comments

Hi, could yo please consider publishing a comparison with Documenter.jl and helping users understand where, when, why they should use this software instead?

Datseris avatar Oct 24 '22 22:10 Datseris

Copying here from Slack:

To answer some questions:

  • Pollen.jl builds the docs for all packages in one go currently, though you can specify for which packages you want to include the documents (i.e. .md/.ipynb files), references (pages for each function/symbol), and source files. Eventually I'd like to support linking to docs that a page doesn't know about during build processes, for example so you can transparently look up the docstrings for a Base function that's used in the documentation, without having to open the Julia Manual or a REPL
  • There's no theming support (yet)
  • It's not released yet, as I've been making a lot of changes to it very the past 2 months, but it's almost there. Following the current setup tutorials should work without a problem, let me know if it does't.
  • The SciMLDocs was a PoC I made to check how well I could integrate pages from multiple Documenter.jl projects, but it's out-of-date now. It does predate MultiDocumenter.jl
  • Pollen.jl is built specifically not to be bound to one package, so including docs for several packages is straightforward.

lorenzoh avatar Oct 25 '22 14:10 lorenzoh

A more thorough comparison will be in the docs when I get closer to releasing. Some things that Pollen.jl can do that Documenter.jl cannot:

  • local preview with hot reload and incremental (re)builds
  • backlinks
  • frontend with Sliding Panes
  • include multiple packages and reference between them

lorenzoh avatar Oct 25 '22 14:10 lorenzoh