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

Support for markdown => 3.6 #217

Open
jonesbusy opened this issue Sep 2, 2024 · 5 comments
Open

Support for markdown => 3.6 #217

jonesbusy opened this issue Sep 2, 2024 · 5 comments

Comments

@jonesbusy
Copy link
Contributor

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 jonesbusy changed the title Support for markdown = 3.6 Support for markdown => 3.6 Sep 2, 2024
@brunobcosta
Copy link

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

@awanlin
Copy link
Collaborator

awanlin commented Sep 11, 2024

Would this get us there? #210

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

@jonesbusy
Copy link
Contributor Author

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

#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 cesaremorel/markdown-inline-graphviz@1c887a7

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

Some folks have open an issue last week: cesaremorel/markdown-inline-graphviz#13

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

Copy link

github-actions bot commented Dec 8, 2024

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 github-actions bot added the stale label Dec 8, 2024
@jonesbusy
Copy link
Contributor Author

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

@github-actions github-actions bot removed the stale label Dec 10, 2024
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