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

Allow to render diagrams from file #12

Merged

Conversation

tsouvarev
Copy link
Contributor

I want to render really big diagrams (BPMN, which is XML), so it's handy to put diagram code in separate file and link it from docs.

@b-bittner
Copy link
Contributor

Hello @tsouvarev ,
thanks for your PR, I appreciate your effort and looking forward to integrate your extension.
It would be helpful for the users if the is something for troubleshooting/logging, when the file does not exists.
Could you please add some logging and maybe also some hint which will be rendered into to docs.

@tsouvarev
Copy link
Contributor Author

tsouvarev commented Aug 19, 2022 via email

@tsouvarev
Copy link
Contributor Author

tsouvarev commented Aug 22, 2022

@b-bittner I've added info message before reading file and error if operation didn't succeed

@b-bittner
Copy link
Contributor

Hello @tsouvarev ,
sorry for the long silence, the last month were no time left for any other stuff than daily business.
Thanks for your added changes, looks much better now. One more thing I would like you to add before I can merge the PR:
Please add the mkdocs-parameter 'docs_dir' as base-path for the file-picking and also include this part of the path in the log message. I would guess, this would help others to find the problem when the plugin can't find the file.

@tsouvarev
Copy link
Contributor Author

@b-bittner thanks for your time and valuable comment! fixed that

@b-bittner b-bittner merged commit e2873ee into AVATEAM-IT-SYSTEMHAUS:main Jan 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants