-
- Notifications
You must be signed in to change notification settings - Fork 3.9k
Description
Context
I use the projects plugin to evaluate mkdocs for a documentation project. Therefore, I need documentation to be aggregated from different repositories.
In particular, I have two issues, one with git-authors, the other with pymdownx.snippets, which make me wonder if the following statement:
Since the projects plugin will invoke local builds in the directory of where your submodules are located, this plugin should work without problems, as it does not use temporary directories.
as the local build works perfectly.
See discussion on git-authors here: timvink/mkdocs-git-authors-plugin#79
Bug description
git-authors plugin reports the following on the project included:
WARNING - [project://.zebbra-mkdocs-dummyproject] [git-authors-plugin] /home/USER/projects/zebbra-mkdocs/submodules/zebbra-mkdocs-dummyproject/docs/index.md has not been committed yet. Lines are not counted ... pymdownx.snippets do not work
Related links
Reproduction
Steps to reproduce
- Clone https://github.com/zebbra/zebbra-mkdocs/tree/mkdocs_projects (make sure the branch is mkdocs_projects, as I am testing different approaches)
- git submodule init
- git submodule update
- pipenv install
- make serve
This will reproduce the error from snippets, you can remove the snippets by clearing the file content in submodules/zebbra-mkdocs-dummyproject/docs/index.md
- Open in browser
- Click on Test in the navigation (this will lead to the project included with the plugin)
- Observe that git authors are empty)
Browser
No response
Before submitting
- I have read and followed the bug reporting guidelines.
- I have attached links to the documentation, and possibly related issues and discussions.
- I assure that I have removed all customizations before submitting this bug report.
- I have attached a .zip file with a minimal reproduction using the built-in info plugin.