Merge branch 'main' of https://openbeagle.org/jkridner/gsoc

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
+]

contrib/index.rst

@@ -9,7 +9,7 @@ you continuously build, test, deploy, and monitor iterative code changes. which
 anything on your local machine to update anything on the site. To contribute to this site, you can follow the 
 simple steps provided below.
 
-.. note:: `OpenBeagle <https://openbeagle.org/>`_ is a self hosted instance of OpenSource program called `GitLab <https://about.gitlab.com/>`_.
+.. note:: `OpenBeagle <https://openbeagle.org/>`_ is a self hosted instance of open source program called `GitLab <https://about.gitlab.com/>`_.
 
 Fork the project
 *****************
@@ -48,16 +48,16 @@ After selecting the file you have to click on ``edit button`` and then choose ei
     :align: center
 
 .. note:: 
-    Choosing Web IDE will load a `Visual Studio Code Server <https://code.visualstudio.com/docs/remote/vscode-server>`_ 
+    Choosing ``Web IDE`` will load a `Visual Studio Code Server <https://code.visualstudio.com/docs/remote/vscode-server>`_
     instance which is a feature rich source code editor. Depending on the internent connection your machine will take some to 
     load the editor and it can be a bit heavy for some machines to handle. Once fully loaded it should run smoothly but, if that is 
-    not the case then please consider using single file editor option. Considering majority of the users will be using Web IDE option, 
-    we are using the Web IDE for the rest of this guide. 
+    not the case then please consider using single file editor option. Considering majority of the users will be using ``Web IDE`` option,
+    we are using the ``Web IDE`` for the rest of this guide.
 
 Start editing
 *************
 
-If you select to open your file in web IDE you'll see a familar interface. The GitLab web IDE is actually a rich 
+If you select to open your file in ``Web IDE`` you'll see a familar interface. The GitLab Web IDE is actually a rich
 `Visual Studio Code Server <https://code.visualstudio.com/docs/remote/vscode-server>`_ hosted on OpenBeagle.
 
 .. image:: media/ide.png
@@ -156,4 +156,4 @@ below shows all the feilds you have to update,
     :align: center
 
 Now wait for the review and if comments/requests are raised then you can continue working on the project 
-until everything looks perfect and your changes are merged in upstream.
\ No newline at end of file
+until everything looks perfect and your changes are merged in upstream.