Skip to content

Add generated_by attribute to page.file#20

Merged
oprypin merged 3 commits intooprypin:masterfrom
timvink:add_generated_attribute
Apr 27, 2023
Merged

Add generated_by attribute to page.file#20
oprypin merged 3 commits intooprypin:masterfrom
timvink:add_generated_attribute

Conversation

@timvink
Copy link
Copy Markdown
Contributor

@timvink timvink commented Nov 28, 2022

This PR adds an attribute to generated files.

Currently, mkdocs-gen-files and mkdocs-git-revision-date-localized-plugin are incompatible.

Using this new attribute, this PR can add support: timvink/mkdocs-git-revision-date-localized-plugin#102

More details in timvink/mkdocs-git-revision-date-localized-plugin#101

@timvink timvink mentioned this pull request Nov 28, 2022
Merged
oprypin
oprypin approved these changes Nov 28, 2022
View reviewed changes
Copy link
Copy Markdown
Owner

@oprypin oprypin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I suppose the src_path attributes are untruthful coming from mkdocs-gen-files.
Perhaps un-setting the src_path would be the cooler solution, but it's also likely to break something else.
So, nice.

@timvink
Copy link
Copy Markdown
Contributor Author

timvink commented Dec 5, 2022

Can you give me a pointer on how to solve the style error?

mkdocs_gen_files/editor.py:48: error: "File" has no attribute "generated_by"  [attr-defined]

@timvink
Copy link
Copy Markdown
Contributor Author

timvink commented Dec 12, 2022

Fixed it.. after a bit of search I released it was a mypy error (I'm not familiar with hatch), # type: ignore fixed it.

@timvink
Copy link
Copy Markdown
Contributor Author

timvink commented Dec 12, 2022

This time it was black. I needed to upgrade also.

p.s. A small section on 'contributing' and how to run the hatch commands would be a nice addition :)

@timvink
Copy link
Copy Markdown
Contributor Author

timvink commented Mar 2, 2023

Hi @oprypin , any blockers to merging this PR? Seems ready to go :)

@pawamoy
Copy link
Copy Markdown

pawamoy commented Apr 26, 2023

I'm interested in this as well (would like to to use mkdocs-git-revision-date-localized-plugin 😉). Let me know if I can be of any help!

oprypin
oprypin approved these changes Apr 27, 2023
View reviewed changes
Copy link
Copy Markdown
Owner

@oprypin oprypin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@oprypin oprypin merged commit 61233e6 into oprypin:master Apr 27, 2023
@oprypin
Copy link
Copy Markdown
Owner

oprypin commented Apr 27, 2023

And released. Sorry for the huge delay.

@squidfunk
Copy link
Copy Markdown

squidfunk commented Aug 18, 2023

Sorry for necroposting, but could we add generated_by to MkDocs' File class? That would allow for better plugin inter-op. Currently, it's added as an anonymous attribute and you can't be sure that it's there. One improvement might be to add the plugin instance to generated_by, so other plugins might even be able to access public state in plugins.

@oprypin oprypin mentioned this pull request Aug 23, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oprypin oprypin oprypin approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@timvink @pawamoy @oprypin @squidfunk