Documenter.jl Enable external files in pages keyword to makedocs

Closes #551

So far this ™️ works on my machine ™️, and the existing tests pass.

In the general case, to add a file that's in your repo but not in the documentation root directory to pages, use: external("relative/path/from/repo/root") or "Page Title" => external("relative/path").

Still to do:

[x] Put external in the docs somewhere
[x] Add tests (Could you point me in the right direction of where I should put them?)

Aug 18 '17 20:08 christopher-dG

Thanks for the feedback! I will address it when I have some time on my hands.

Sep 26 '17 13:09 christopher-dG

:+1: This will be really useful for the new "default packages" structure.

Sep 28 '17 01:09 JeffBezanson

Hey, sorry this has gone ignored for so long -- I'll make an effort to work on this this weekend.

Nov 02 '17 18:11 christopher-dG

Okay, this should be ready for another review.

Nov 04 '17 17:11 christopher-dG

I've rebased this, we'll see if I can resurrect it :slightly_smiling_face:

Mar 07 '19 05:03 christopher-dG

I'm really interested in this, is it still being worked on?

Oct 25 '19 18:10 jlumpe

Not by me at the moment, but maybe one day I'll come back to it... Or if someone wants to take over the branch they can feel free.

Oct 27 '19 13:10 christopher-dG

I have a slightly updated version of this, but it also needs a bit more work (which is also unfortunately unlikely to happen any time too soon): https://github.com/JuliaDocs/Documenter.jl/issues/1074#issuecomment-515477974

Oct 29 '19 10:10 mortenpi

This sounds like a nice feature to have, but last discussions here were in 2019. Back then @mortenpi hinted he might have an alternative implementation...

@christopher-dG are you still interested in this feature, and/or in reviving this PR?

Nov 01 '25 14:11 fingolfin