From a9142acf2081037422390ef444a6215845734bf6 Mon Sep 17 00:00:00 2001 From: Jason Kridner <jkridner@beagleboard.org> Date: Wed, 31 Jan 2024 23:35:56 -0500 Subject: [PATCH] Use 'Edit on OpenBeagle' --- conf.py | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/conf.py b/conf.py index a86d54b..9b15633 100644 --- a/conf.py +++ b/conf.py @@ -33,11 +33,10 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'env', ".venv"] pages_url = "https://gsoc.beagleboard.io" pages_slug = "latest" -gitlab_user = "gsoc" -gitlab_version = "main" -gitlab_url = "https://openbeagle.org" -gitlab_repo = "gsoc.beagleboard.io" -docs_url = "https://gsoc.beagleboard.io/latest/" + +# What was here was not part of the "General configuration" +# first place I could find something was at https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html + # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output @@ -113,16 +112,19 @@ html_theme_options = { html_context = { "display_gitlab": True, - "gitlab_url": gitlab_url, - "gitlab_user": gitlab_user, - "gitlab_repo": gitlab_repo, + "gitlab_url": "https://openbeagle.org", + "gitlab_user": "gsoc", + "gitlab_repo": "gsoc.beagleboard.io", "gitlab_version": "main", "doc_path": "", "conf_py_path": "", "show_license": True, - "pages_url": pages_url, - "pages_slug": pages_slug, - "docs_url": docs_url, + "pages_url": "https://gsoc.beagleboard.io", + "pages_slug": "", + "docs_url": "https://docs.beagleboard.org/latest/", + "edit_page_url_template": "{{ my_vcs_site }}{{ file_name }}", + "edit_page_provider_name": "OpenBeagle", + "my_vcs_site": "https://openbeagle.org/gsoc/gsoc.beagleboard.io/-/edit/main/", } # -- Options for proposal PDF generation -- @@ -145,4 +147,4 @@ latex_engine = "xelatex" latex_logo = str("_static/images/logo-latex.pdf") latex_documents = [ ("proposals/template", "template.tex", "Project proposal template 2024", "John Doe", "manual"), -] \ No newline at end of file +] -- GitLab