mkdocs-techdocs-core icon indicating copy to clipboard operation
mkdocs-techdocs-core copied to clipboard

Support for markdown => 3.6

Open jonesbusy opened this issue 1 year ago • 2 comments

Hi,

Can we update constraint on

https://github.com/backstage/mkdocs-techdocs-core/blob/main/requirements.txt#L5

- Markdown>=3.2,<3.4
+ Markdown>=3.2,<3.8

Started to see

[05:25:27.580+02:00] - The conflict is caused by:
[05:25:27.580+02:00] -     mkdocstrings 0.26.0 depends on Markdown>=3.6
[05:25:27.580+02:00] -     mkdocs-techdocs-core 1.4.1 depends on Markdown<3.4 and >=3.2

When other mkdocs plugin required markdown >=3.6

Possible fixed by renovate PR : https://github.com/backstage/mkdocs-techdocs-core/pull/210/files

But not sure why it's not building

jonesbusy avatar Sep 02 '24 03:09 jonesbusy

I would also like this upgrade, this conflict with mkdocstring blocks a functionality that I care about.

In addition, I am wondering if this constraint is necessary, since mkdocs itself has this dependency in a newer version: "Markdown >=3.3.6",

https://github.com/mkdocs/mkdocs/blob/bb7e8b62185b11d9f59bb7f50b13c15134f62f8a/pyproject.toml#L39

brunobcosta avatar Sep 11 '24 01:09 brunobcosta

Would this get us there? https://github.com/backstage/mkdocs-techdocs-core/pull/210

If yes some help getting the CI green would be great!

awanlin avatar Sep 11 '24 01:09 awanlin

ERROR   -  Error reading page 'index.md': InlineGraphvizExtension.extendMarkdown() missing 1 required positional argument: 'md_globals'
Traceback (most recent call last):

https://github.com/backstage/mkdocs-techdocs-core/pull/87

This is highlightedby an integration test that fail at runtime https://github.com/cesaremorel/markdown-inline-graphviz that is outdated

This was fixed on https://github.com/cesaremorel/markdown-inline-graphviz/commit/1c887a7b3ab752c7decb838eabbaf72f87bfb2d2

But for some reason not released yet. Hope the maintainer will answer

Some folks have open an issue last week: https://github.com/cesaremorel/markdown-inline-graphviz/issues/13

So until then we cannot do anything I guess (unless we drop graphviz support on mermaid ?)

jonesbusy avatar Oct 08 '24 11:10 jonesbusy

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Dec 08 '24 01:12 github-actions[bot]

Not stale. Also missing release

Release failed

ERROR    HTTPError: 400 Bad Request from https://upload.pypi.org/legacy/        
         Can't have direct dependency: markdown_inline_graphviz_extension@      
         git+https://github.com/cesaremorel/markdown-inline-graphviz.git@579f10a
         f9fe7[187](https://github.com/backstage/mkdocs-techdocs-core/actions/runs/12075049793/job/33674158694#step:6:193)c717c20615f65774f898c1a0d. See                                 
         https://packaging.python.org/specifications/core-metadata for more     
         information.

Apparently not possible to publish due to the git dependency

If https://github.com/cesaremorel/markdown-inline-graphviz is abandonned and we don't get any answer from a maintainer we should consider either dropping the dependency (and accept breaking changes) or created a fork.

Right now this is not a long term solution for the mkdocs-techdocs-core CLI

jonesbusy avatar Dec 09 '24 10:12 jonesbusy

We ended up forking https://github.com/cesaremorel/markdown-inline-graphviz to https://github.com/backstage/markdown-inline-graphviz under a new pypi project.

Hopefully this helps unblock us.

PeaWarrior avatar Jan 28 '25 17:01 PeaWarrior

We ended up forking https://github.com/cesaremorel/markdown-inline-graphviz to https://github.com/backstage/markdown-inline-graphviz under a new pypi project.

Hopefully this helps unblock us.

Thanks. I think it's a much better solution

jonesbusy avatar Jan 29 '25 13:01 jonesbusy