search

ojacques / mkdocs-git-committers-plugin-2

MkDocs plugin for displaying a list of GitHub (.com or Enterprise) contributors on each page. Encourages contributions to the documentation!
MIT License
58 stars 21 forks source link

Authors does not show in GitLab self-host #55

Open mahdisn76 opened 6 months ago

mahdisn76 commented 6 months ago

I am using GitLab self-hosted and set the mkdocs configs based on the documents.

plugins:
  - git-committers:
      token: '...'
      gitlab_hostname: 'git.example.com'
      api_version: 'v4'
      gitlab_repository: 619
      branch: 'main'

What I see is that the commit details including avatar and other things are fetching correctly.

But event though I am using material theme, it does not show any thing at the bottom of the document pages.

Any help?

aradovic-at-symmetry commented 4 months ago

I have the same issue.

ojacques commented 4 months ago

Thanks both for the report. I use GitLab self-hosted myself, and the plugin works. Let's figure this out.

What is interesting is that the plugin seems activated and correctly fetches page authors.

Thanks.

mahdisn76 commented 4 months ago

Yes, I'm still having the issue. @ojacques I have tested it on Linux (Ubuntu 22.04). This is mkdocs server command output:

INFO     -  Building documentation...
WARNING  -  Config value: 'plugins'. Warning: ('api_version', 'Unrecognised configuration name: api_version')
INFO     -  git-committers plugin ENABLED
INFO     -  git-committers: found page authors cache file - loading it
INFO     -  git-committers: fetching contributors for docs/experiences.md
INFO     -  git-committers: fetching contributors for docs/grafana_dashboard.md
INFO     -  git-committers: saving page authors cache file
INFO     -  [15:35:19] Reloading browsers
INFO     -  [15:35:19] Browser connected: http://127.0.0.1:8000/experiences/

The page-authors.json file generation process is completely Ok, but it still does not show any thing at the bottom of the document pages. Should i do anything with the theme?

mahdisn76 commented 4 months ago

Oh! I just updated my mkdocs packages and now it works fine!

pip install --upgrade mkdocs
pip install --upgrade mkdocs-material

Thanks!