.gitlab-ci.yml

-image: beagle/sphinx-build-env:latest
+# The Docker image that will be used to build your app
+image: registry.git.beagleboard.org/docs/sphinx-build-env:latest
 
 pages:
   tags:
   - docker-amd64
+  before_script:
+  - source ./venv-build-env.sh
   script:
-  - sphinx-build -b html . public
+  - "./gitlab-build.sh"
   artifacts:
     paths:
-    - public
\ No newline at end of file
+    - public

Makefile

@@ -14,6 +14,9 @@ help:
 
 .PHONY: help Makefile
 
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

README.md

@@ -6,7 +6,7 @@ Status updates for BeagleBoard.org's Google Summer of Code program.
 
 Primary resources:
 
-* [Forum](https://forum.beagleboard.org/c/gsoc)
+* [Forum](https://bbb.io/gsocml)
 * [Live chat](https://bbb.io/gsocchat)
 * [Project documentation template](https://gsoc.beagleboard.io/project-docs-template)
 

_static/epilog/external.links

+.. _C:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/c.html
+
+.. _Assembly:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/assembly.html
+
+.. _Verilog:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/verilog.html
+
+.. _Zephyr:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/zephyr.html
+
+.. _Linux:
+   https://docs.beagleboard.cc/latest/intro/beagle101/linux.html
+
+.. _device-tree:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/device-tree.html
+
+.. _FPGA:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/fpga.html
+
+.. _basic wiring:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/basic-wiring.html
+
+.. _motors:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/motors.html
+
+.. _embedded serial interfaces:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/embedded-serial.html
+
+.. _OpenBeagle CI:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/openbeagle-ci.html
+
+.. _verification:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/verification.html
+
+.. _wireless communications:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/wireless-communications.html
+
+.. _Buildroot:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/buildroot.html
+
+.. _RISC-V ISA:
+   https://docs.beagleboard.cc/docs/latest/intro/beagle101/riscv.html
\ No newline at end of file

_static/latex/preamble.tex

+% LaTeX documentation preamble
+%
+% Copyright (c) 2021 Nordic Semiconductor ASA
+% SPDX-License-Identifier: Apache-2.0
+
+\usepackage[some]{background}
+\usepackage{sectsty}
+\usepackage{lscape}
+\usepackage{longtable}
+\usepackage{fontspec}
+\usepackage{comment}
+\defaultfontfeatures{Mapping=tex-text,Scale=MatchLowercase}
+\setmainfont{DejaVuSans}
+\setmonofont{FreeMono}
+
+\definecolor{bg-color}{HTML}{a97f2c}
+
+\setcounter{tocdepth}{2}
+
+\addto\captionsenglish{\renewcommand{\contentsname}{Table of contents}}
+
+\allsectionsfont{\color{bg-color}}
+
+\let\oldtabular\tabular
+\renewcommand{\tabular}{\footnotesize\oldtabular}

_static/latex/title.tex

+% LaTeX documentation title page
+%
+% Copyright (c) 2021 Nordic Semiconductor ASA
+% SPDX-License-Identifier: Apache-2.0
+
+\makeatletter
+\newgeometry{top=3cm,left=0cm,right=0cm,bottom=2.5cm}
+
+\backgroundsetup{
+    scale=1,
+    contents={\sphinxlogo},
+    opacity=0.7,
+    angle=0,
+    position={0.40\textwidth,-0.60\textheight}
+}
+
+\BgThispage
+
+\begin{minipage}{2cm}
+    \color{bg-color} \rule{2cm}{1.7cm}
+\end{minipage}
+\hspace{0.2cm}
+\begin{minipage}{2cm}
+    \sphinxlogo
+\end{minipage}
+\hspace{0.2cm}
+\begin{minipage}{14cm}
+    \color{bg-color} \Large \textbf{\@title}
+\end{minipage}
+
+\vspace{21cm}
+
+\begin{flushright}
+    \begin{minipage}{4cm}
+        \large \@author\\\@date
+    \end{minipage}
+    \begin{minipage}{1.5cm}
+        \color{bg-color} \rule{1.5cm}{1.3cm}
+    \end{minipage}
+\end{flushright}
+
+\restoregeometry
+\makeatother

_templates/forum.html

+{% if pagename == "ideas/index" %}
+    <a role="button" href="https://bbb.io/gsocml">
+        <i class="fa-brands fa-discourse"></i> More Ideas on Forum
+    </a>
+{% else %}
+    <a role="button" href="https://forum.beagleboard.org/new-topic?category=gsoc&tags=gsoc">
+        <i class="fa-brands fa-discourse"></i> Discuss on Forum
+    </a>
+{% endif %}
+
+<div class="card bg-light mt-4 text-center">
+    <div class="card-body">
+      <p class="card-text text-dark">
+        <a href="https://www.beagleboard.org/">BeagleBoard.org</a> is all about being open, please discuss in public on our <a href="https://bbb.io/gsocml">forum</a>!</p>
+    </div>
+</div>
\ No newline at end of file

_templates/mission.html

+<div class="card bg-light mt-4 text-center">
+    <div class="card-header bg-primary text-light">
+        What is the mission?
+    </div>
+    <div class="card-body">
+    <p class="card-text text-dark">
+        We don’t want to just make more things. We want to enable individuals to make the things that dominate their lives, rather than leaving it up to someone else. Google Summer of Code with BeagleBoard.org is a great way to learn skills highly in demand while making a difference in the world.
+    </p>
+    </div>
+</div>
+
+<div class="card bg-light mt-4 text-center">
+    <div class="card-header bg-success text-light">
+        How to build an embedded system?
+    </div>
+    <div class="card-body">
+    <p class="card-text text-dark">
+        An embedded system is built using a computer dedicated to a specific purpose, like a toaster, coffee machine, dish washer, thermostat or anti-lock brakes. You can think of an embedded system as a computer designed to not look like a computer and to automate things in the physical world. The <a href="https://www.beagleboard.org/">BeagleBoard.org</a> community is loaded with experts on building open source embedded systems, join our <a href="https://bbb.io/gsocml">forum</a> to connect. 
+    </p>
+    </div>
+</div>
\ No newline at end of file

_templates/pdf.html

+{% if pages_slug != "index" %}
+    {% for proposal_name in proposals %}
+        {% if pagename == "proposals/"+proposal_name %}
+            <a role="button" href="{{proposal_name}}.pdf">
+                <i class="fa-solid fa-download"></i> Download PDF
+            </a>
+        {% endif %}
+    {% endfor %}
+{% endif %}
\ No newline at end of file

conf.py

@@ -10,21 +10,32 @@ import os
 import sys
 from pathlib import Path
 from typing import Any, Dict
-
+from os import walk
 import pydata_sphinx_theme
 from sphinx.application import Sphinx
 
 sys.path.append(str(Path(".").resolve()))
 
 project = 'gsoc.beagleboard.io'
-copyright = '2024, BeagleBoard.org'
+copyright = '2025, BeagleBoard.org'
 author = 'BeagleBoard.org'
 
+# Add epilog details to rst_epilog
+rst_epilog =""
+rst_epilog_path = "_static/epilog/"
+for (dirpath, dirnames, filenames) in os.walk(rst_epilog_path):
+    for filename in filenames:
+        with open(dirpath + filename) as f:
+            rst_epilog += f.read()
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     "sphinx_design",
+    "sphinxcontrib.youtube",
+    "sphinxcontrib.images",
+    "sphinx_copybutton"
 ]
 
 templates_path = ['_templates']
@@ -32,11 +43,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
@@ -53,9 +63,32 @@ html_css_files = [
     'css/custom.css',
 ]
 
+# Pages entry without primary (left) sidebar
+
+html_sidebars = {
+    "**": ["sidebar-nav-bs", "mission"],
+    "ideas/index": [],
+    "index": []
+}
+
 html_theme_options = {
+    "external_links": [
+        {
+            "url": "https://summerofcode.withgoogle.com/help",
+            "name": "Help",
+        },
+        {
+            "url": "https://summerofcode.withgoogle.com/rules",
+            "name": "Rules",
+        },
+        {
+            "url": "https://summerofcode.withgoogle.com/terms",
+            "name": "Terms",
+        },
+    ],
     "header_links_before_dropdown": 4,
-     "icon_links": [
+    "show_prev_next": True,
+    "icon_links": [
         {
             "name": "OpenBeagle",
             "url": "https://openbeagle.org/",
@@ -70,13 +103,13 @@ html_theme_options = {
         },
         {
             "name": "Discord",
-            "url": "https://discord.com/invite/e58xECGWfR",
+            "url": "https://bbb.io/gsocchat",
             "icon": "fa-brands fa-discord",
             "attributes": {"target": "_blank"},
         },
         {
-            "name": "Fourm",
-            "url": "https://forum.beagleboard.org/c/gsoc",
+            "name": "Forum",
+            "url": "https://bbb.io/gsocml",
             "icon": "fa-brands fa-discourse",
             "attributes": {"target": "_blank"},
         },
@@ -98,28 +131,68 @@ html_theme_options = {
     "use_edit_page_button": True,
     "show_toc_level": 1,
     "navbar_align": "right",
-    "show_nav_level": 2,
-    "announcement": "Welcome to new site for BeagleBoard.org GSoC 2024 projects!",
+    "show_nav_level": 1,
+    "announcement": "Welcome to the site for BeagleBoard.org GSoC 2025 projects!",
     # "show_version_warning_banner": True,
     "navbar_center": ["navbar-nav"],
     "navbar_start": ["navbar-logo"],
     "navbar_end": ["theme-switcher", "navbar-icon-links"],
     # "navbar_persistent": ["search-button"],
     "footer_start": ["copyright"],
-    "footer_center": ["sphinx-version"],
+    "footer_end": ["last-updated"],
     # "content_footer_items": ["last-updated"],
+    "secondary_sidebar_items": {
+        "**": ["page-toc", "edit-this-page", "sourcelink","pdf","forum"]
+    },
 }
 
+proposals = []
+proposal_filenames = next(walk("proposals"), (None, None, []))[2]
+for proposal_filename in proposal_filenames:
+    proposal_filename = os.path.splitext(proposal_filename)[0]
+    if proposal_filename != "index":
+        proposals.append(proposal_filename)
+
+print(proposals)
+
 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/",
+    "proposals":proposals
+}
+
+# -- Options for proposal PDF generation --
+latex_elements = {
+    "papersize": "a4paper",
+    "maketitle": open("_static/latex/title.tex").read(),
+    "preamble": open("_static/latex/preamble.tex").read() + r"\let\cleardoublepage\clearpage",
+    "sphinxsetup": ",".join(
+        (
+            "verbatimwithframe=false",
+            "VerbatimColor={HTML}{f0f2f4}",
+            "InnerLinkColor={HTML}{2980b9}",
+            "warningBgColor={HTML}{e9a499}",
+            "warningborder=0pt",
+            r"HeaderFamily=\rmfamily\bfseries",
+        )
+    ),
 }
+
+sd_fontawesome_latex = True
+latex_engine = "xelatex"
+latex_logo = str("_static/images/logo-latex.pdf")
+latex_documents = []
+for proposal in proposals:
+    latex_documents.append(("proposals/"+proposal, proposal+".tex", "",author, "manual"))

gitlab-build.sh

+#!/bin/bash -xe
+mkdir -p public
+
+echo "**** Updating $PAGES_URL/$VER_DIR ****"
+echo "**** env ****"
+env
+
+# Clean build directory
+make clean BUILDDIR=public
+
+# Render HTML
+make html BUILDDIR=public
+mv public/html/* public/
+
+# Render PDF
+make latexpdf BUILDDIR=public/
+mv public/latex/*.pdf public/proposals
+
+# Cleanup
+echo "**** cleanup ****"
+rm -rf public/doctrees
+rm -rf public/latex
+
+echo "**** env ****"
+env
\ No newline at end of file

guides/contributor.rst

+.. _gsoc-contributor-guide:
+
+Contributor Guide 
+#################
+
+.. youtube:: YN7uGCg5vLg
+    :width: 100%
+    :align: center
+
+.. important::
+
+   Contributors will be expected to execute a series of prerequisites to demonstrate and
+   expand familiarity with embedded systems development. Don't worry, the
+   `live chat <https://bbb.io/gsocchat>`_ channel has over 1,000 active members to
+   travel with you on your journey.
+
+General requirements
+********************
+
+.. note::
+
+   Google Summer of Code is open to individuals age 18 and older in most countries who are new or beginner
+   contributors to open source coding projects. Read more on the GSoC site
+   `Rules page <https://summerofcode.withgoogle.com/rules>`_ and the
+   `FAQ page <https://developers.google.com/open-source/gsoc/faq>`_.
+
+All projects have the following basic requirements:
+
+1. Contributors must create accounts on our `OpenBeagle <https://openbeagle.org/>`_, `Discord <https://bbb.io/gsocchat>`_ and `Beagle Forum <http://bbb.io/gsocml>`_ prior to creating their application.
+2. All newly generated materials must be released under an `open source license <http://www.opensource.org/licenses>`_. Individual contributors shall retain copyright on their works.
+3. Contributors will demonstrate their ability to cross-compile and utilize version control software by creating a “Hello World” application and generating a pull request to `jadonk/gsoc-application <https://github.com/jadonk/gsoc-application/tree/master/ExampleEntryJasonKridner>`_. For assistance, please visit our `Discord <https://bbb.io/gsocchat>`_ or utilize the `Beagle Forum <http://bbb.io/gsocml>`_. The “Hello World” application must print your name and the date out in an ARM Linux environment. Freely available emulators may be used to test your application or you can ask anyone on the chat or mailing list to help you test.
+4. All projects will produce reusable software components and will not be “what-I-built-over-my-summer-vacation” projects. Including a hardware component is welcome, but the project deliverable will be software that may be utilized by a wide audience of the `BeagleBoard.org <https://www.beagleboard.org/>`_ community.
+5. Contributors will demonstrate their ability to collaborate by creating a project proposal on this site using our :ref:`proposal template <gsoc-proposal-template>` and utilizing our `Discord <https://bbb.io/gsocchat>`_ to collect quotes regarding the usefulness of their proposal to the `BeagleBoard.org <https://www.beagleboard.org/>`_ community. **Use of Google Docs for proposal development is discouraged due to insufficient revision control and extensive use of computing resources having numerous documents open simultaneously**.
+6. Source code generated during the project must be released on `OpenBeagle <https://openbeagle.org/>`_ (and we’ll setup a mirror on `Github.com <http://github.com/>`_).
+7. Contributors will provide two recorded audio/video presentations uploaded to Youtube or Vimeo (screencasts are appropriate), one near the beginning of the project summarizing their project goals and another in the wrap-up phase to summarize their accomplishments. Examples can be found in :ref:`Past_Projects`. There is no requirement to show your faces or use English.
+
+.. important:: 
+
+    To help you to break your project down into manageable chunks and also to help the project’s mentors to better support 
+    your efforts, weekly project status reports should be e-mailed to the the `Beagle Forum <http://bbb.io/gsocml>`_. 
+    Each status report should be posted by every Monday and must include these outlines:
+
+    1. Accomplishments
+    2. Resolutions to blockers
+    3. On-going blockers
+    4. Plans for this week
+
+    For example, `Weekly Progress Report Thread: 
+    Cape Compatibility <https://forum.beagleboard.org/t/weekly-progress-report-thread-cape-compatibility/28709/9>`_
+
+Contributor proposals can encompass projects based on the :ref:`ideas page <gsoc-project-ideas>`  or can include personal project ideas, 
+but should be focused on generating a sustainable and reusable open source software component. Previous Google Summer of Code projects show 
+that the key to success is being passionate about your project, so propose something that is extremely interesting to you, even 
+if it is not on this list. We will be glad to help contributors develop ideas into projects via our `Discord <https://bbb.io/gsocchat>`_ 
+and `Forum <https://bbb.io/gsocml>`_. There are many potential project ideas and we will match contributors to projects 
+based on their interests and help scope the proposals to something that can be completed in the Summer of Code timeframe.
+
+.. tip::
+   There are more than a thousand existing projects listed at `Projects Archive <http://www.beagleboard.org/projects>`_. 
+   If you are interested in any of the projects listed on the `BeagleBoard.org <https://www.beagleboard.org/>`_ projects page, 
+   contact the project members to see if there are any aspects of their projects that can be enhanced to create a GSoC project. 
+   There are also several ideas on the `ECE497 class project idea list <https://elinux.org/ECE497_Project_Ideas>`_. 
+   Note, however, we are looking for projects that provide a service to the developer community and aren’t simply “look what cool 
+   thing I made or you can make”. The projects should provide a useful software component for other people to utilize.
+

guides/index.rst

+.. _gsoc-guides:
+
+Guides
+######
+
+.. youtube:: 7jD2tChhrWM
+   :width: 100%
+   :align: center
+
+.. admonition:: What is Google Summer of Code?
+   :class: admonition-code
+
+   Spend your summer break writing code and learning about open source development while earning money!
+   Accepted contributors work with a mentor and become a part of the open source community. Many become lifetime
+   open source developers! The 2025 contributor application window will be open from
+   `March 24 2025 <https://opensource.googleblog.com/2025/01/google-summer-of-code-2025-is-here.html>`_ to
+   `April April 8 2025 <https://opensource.googleblog.com/2025/01/google-summer-of-code-2025-is-here.html>`_!
+   But don't wait for then to engage! Come to our `Discord <https://bbb.io/gsocchat>`_ and
+   `Forum <https://bbb.io/gsocml>`_ to share ideas today.
+
+This section includes guides for :ref:`contributors <gsoc-contributor-guide>` & :ref:`mentors <gsoc-mentor-guide>` who want to participate 
+in GSoC 2025 with `BeagleBoard.org <www.beagleboard.org>`_. It's highly recommended to check `GSoC Frequently Asked Questions 
+<https://developers.google.com/open-source/gsoc/faq>`_. For anyone who just want to contribute to this site we also have 
+a step by step :ref:`contribution guide <gsoc-site-editing-guide>`.
+
+.. card::
+    :link: gsoc-contributor-guide
+    :link-type: ref
+
+    :fas:`graduation-cap` **Contributor Guide**
+    ^^^^
+
+    If you want to increase your chances of being accepted into (and succeed during) Google Summer of Code, we strongly 
+    encourage you to read this guide! It is particularly helpful for tips on writing a good project proposal and how 
+    potential contributors should interact with the communities they are interested in working with during the program.
+
+.. card:: 
+    :link: gsoc-mentor-guide
+    :link-type: ref 
+        
+    :fas:`person-chalkboard` **Mentor Guide**
+    ^^^^
+
+    If you want to mentor for GSoC this year, read this short guide made for mentors wondering where to help.
+
+.. card:: 
+    :link: gsoc-proposal-guide
+    :link-type: ref 
+        
+    :fas:`file` **Proposal Guide**
+    ^^^^
+
+    To create an proposal on ``gsoc.beagleboard.io``, we have provided a reStructuredText template. The tamplate can be used 
+    to create a live HTML version of the proposal as well as generate a PDF version for GSoC submission.
+
+.. card:: 
+    :link: gsoc-site-editing-guide
+    :link-type: ref 
+        
+    :fas:`file-signature` **Site Editing Guide**
+    ^^^^
+
+    For anyone who is looking to make changes to the ``gsoc.beagleboard.io`` site, you can checkout our site editing guide. We have 
+    provided information on how to use OpenBeagle's integrated ``Web IDE`` for editing, ``CI`` for building and ``pages`` for 
+    serving the rendered content.
+
+
+
+.. toctree:: 
+    :hidden:
+    :maxdepth: 2
+
+    contributor
+    mentor
+    proposal
+    site-editing