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

DocumenterMarkdown #64

Closed
orenbenkiki opened this issue Apr 2, 2024 · 3 comments
Closed

DocumenterMarkdown #64

orenbenkiki opened this issue Apr 2, 2024 · 3 comments

Comments

@orenbenkiki
Copy link

The MadsPublish.jl imports DocumenterMarkdown, though it seems it doesn't use it. It generates the output in HTML format, which is already covered by format=Documenter.Writers.HTMLWriter; the DocumentedMarkdown allows generating Markdown output using format=DocumenterMarkdown.Markdown, which isn't used.

This wouldn't be a problem except that DocumenterMarkdown only works with pre-1.0 versions of Documenter, so installing Mads forces Documenter to an old version (0.27.25), which has an incompatible API with the 1.* Documenter versions, breaking anything that is using the latest (presumably stable?) Documenter 1.* API.

It also wouldn't have been a problem if DocumenterMarkdown was being updated, but according to JuliaDocs/DocumenterMarkdown.jl#11 it doesn't seem like this would be any time soon.

How about simply removing DocumenterMarkdown as a dependency of Mads?

@asinghvi17
Copy link

FYI there is JuliaDocs/DocumenterMarkdown#13 which will transition DocumenterMarkdown to v1 of Documenter. That should happen sometime this month.

@orenbenkiki
Copy link
Author

orenbenkiki commented Apr 2, 2024

Ugh, missed it. My bad.

Still - if DocumenterMarkdown isn't ever used, why make it a dependency and import it in the 1st place? Or am I missing something additional?

@montyvesselinov
Copy link
Member

DocumenterMarkdown has been removed. I agree with your comments. We are working to compertamentalize the packages.

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

3 participants