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

Incompatibility with submodules (using mkdocs-monorepo-plugin) #23

Open
prcr opened this issue Nov 14, 2020 · 4 comments
Open

Incompatibility with submodules (using mkdocs-monorepo-plugin) #23

prcr opened this issue Nov 14, 2020 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@prcr
Copy link
Contributor

prcr commented Nov 14, 2020

Hello,

I started using mkdocs-rss-plugin but noticed that at the moment it's not compatible with mkdocs-monorepo-plugin. When I run mkdocs build I get the following output letting me know that the plugin couldn't find the dates for files in the submodules (in this case, the ones inside submodules/chart/):

$ mkdocs build
INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/paulo/docs/site 
WARNING -  Dates could not be retrieved for page: /home/paulo/docs/submodules/chart/docs/index.md.
WARNING -  Dates could not be retrieved for page: /home/paulo/docs/submodules/chart/docs/requirements.md.
WARNING -  Dates could not be retrieved for page: /home/paulo/docs/submodules/chart/docs/configuration/monitoring.md.
WARNING -  Dates could not be retrieved for page: /home/paulo/docs/submodules/chart/docs/configuration/integrations/bitbucket-cloud.md.
WARNING -  Dates could not be retrieved for page: /home/paulo/docs/submodules/chart/docs/configuration/integrations/bitbucket-server.md.
[...]

Since this plugin is based on the plugins by Tim Vink (which I'm also using), I checked how those plugins work and they determine the local Git repository for each file before using Git to obtain the metadata on the file, as seen here:

https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/blob/d4303ad2efd4d4cda49116d8e8bdb0aa5012d4d3/mkdocs_git_revision_date_localized_plugin/util.py#L91

Would you be willing to implement the same mechanism on mkdocs-rss-plugin to make it compatible with submodules?

@prcr prcr changed the title Incompatibility with mkdocs-monorepo-plugin Incompatibility with submodules (using mkdocs-monorepo-plugin) Nov 14, 2020
@Guts Guts self-assigned this Nov 15, 2020
@Guts Guts added the enhancement New feature or request label Nov 15, 2020
@Guts
Copy link
Owner

Guts commented Nov 15, 2020

Right, I'll have a closer look and try to implement a similar mechanism.

@prcr
Copy link
Contributor Author

prcr commented Nov 15, 2020

Thank you!

I started thinking if in the future it would make sense to have a shared util.py module that would gather the functionality needed by all these MkDocs plugins that retrieve data from Git. Perhaps this could be easier to maintain going forwards. But I totally understand that for now, it's probably much simpler to just replicate the logic on your own plugin. 👍

prcr pushed a commit to codacy/docs that referenced this issue Nov 15, 2020
As of now, the plugin doesn't support submodules. I opened a ticket
on the GitHub project for the plugin:

Guts/mkdocs-rss-plugin#23
@Guts
Copy link
Owner

Guts commented Nov 16, 2020

@timvink has already imagined this scenario for his plugins and I've proposed to integrate the RSS plugin along the others. See: timvink/mkdocs-git-authors-plugin#16 (comment)

@timvink
Copy link
Contributor

timvink commented Jan 26, 2021

Yup, common utils for accessing git for mkdocs files would be better. Very low on my priority list though and needs to be well designed.. feel free to pick it up!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants