Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comparison with Documenter.jl? #104

Open
Datseris opened this issue Oct 24, 2022 · 2 comments
Open

Comparison with Documenter.jl? #104

Datseris opened this issue Oct 24, 2022 · 2 comments

Comments

@Datseris
Copy link

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

@lorenzoh
Copy link
Owner

lorenzoh commented Oct 25, 2022

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
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants