Skip to content

Automatically add "Edit on GitLab" links to documentation pages for repositories hosted on GitLab.com #2910

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

Closed
mlncn opened this issue May 25, 2017 · 2 comments
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Milestone

Comments

@mlncn
Copy link
Contributor

mlncn commented May 25, 2017

Details

Just as "Edit on GitHub" and "Edit on BitBucket" links are automatic, so can "Edit on GitLab" links be.

Workaround

The functionality is evidently already there (awesome!) as seen on our project, it only took adding these lines to conf.py:

html_context = {
    "display_gitlab": True, # Integrate Gitlab
    "gitlab_user": "drutopia", # Organization or User
    "gitlab_repo": "documentation", # Repo name
    "gitlab_version": "master", # Version
    "conf_py_path": "/", # Path in the checkout to the docs root
}

The next step is to make this automatic.

@ghost
Copy link

ghost commented Jul 19, 2017

Hey, @mlncn,

I'll be adding the Enhancement and Needed: design decision labels to this ticket with the triage process. As you could imagine, ReadTheDocs receives an extraordinary amount of tickets and issues through GitHub every week, and because of the smaller team, your request may take on the upside of several days to be processed and reviewed by the team.

Thank you for your patience,
ItsPugle - ReadTheDocs Triage Team

@ghost ghost added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Jul 19, 2017
@humitos humitos added this to the Gitlab milestone Dec 1, 2017
@humitos
Copy link
Member

humitos commented Dec 27, 2017

@benjaminp Hi! This should be working after #3327 got merged and deployed.

@humitos humitos closed this as completed Dec 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants