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

Fixes to servedocs (+minor release) #127

Merged
merged 2 commits into from
Jul 13, 2021
Merged

Fixes to servedocs (+minor release) #127

merged 2 commits into from
Jul 13, 2021

Conversation

tlienart
Copy link
Collaborator

@tlienart tlienart commented Jul 12, 2021

closes #125
closes #126

Testing

  • Ran servedocs(skip_dir="docs/src/generated") on the Literate.jl repo, modified outputformats.md (picked up ✔️) modified outputformats.jl (picked up ✔️)

@fredrikekre I intend to merge this soon but there's one element I'd like your opinion on, could you ran the following example with this branch:

using LiveServer, Documenter, Literate
LiveServer.servedocs_literate_example()
cd("servedocs_literate_example/")
servedocs(literate=joinpath("docs", "literate"))

There's a bunch of <unknown> added e.g.:

```@meta
EditURL = "<unknown>/docs/literate/man/pg1.jl"
```

I think this comes from Literate. It looks like stuff works fine but it shows a bunch of warnings in the REPL. Anything that could be done to maybe disable some checks on that front? or is it a Documenter issue? Thanks!

@fredrikekre
Copy link
Member

Great, thanks.

I think this comes from Literate.

Yep, and those are expected to be <unknown> unless running on GH Actions or similar.

Anything that could be done to maybe disable some checks on that front?

I mean, you can filter out those log messages I suppose, but personally I am not bothered by them since I am generally not looking at that terminal window anyway. It is also happening from just julia docs/make.jl so people using Literate have probably already seen them. I don't think it is LiveServers job to hide them.

@tlienart
Copy link
Collaborator Author

Sounds good, thanks for the clarifications

@tlienart tlienart merged commit d9793aa into master Jul 13, 2021
@tlienart tlienart deleted the servedocs branch July 13, 2021 09:21
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

Successfully merging this pull request may close these issues.

[FR] Option to watch more directories in servedocs Specific file is not watched
2 participants