diff --git a/_static/images/logo-latex.pdf b/_static/images/logo-latex.pdf index deaa2699d6de4ab582af1ae276ca36d8f341cca0..5491dbf79bebb11b097c750078a4402941b6a9b8 100644 Binary files a/_static/images/logo-latex.pdf and b/_static/images/logo-latex.pdf differ diff --git a/_static/latex/preamble.tex b/_static/latex/preamble.tex new file mode 100644 index 0000000000000000000000000000000000000000..e13368a5c75605a23fd88423ca902350431ef83f --- /dev/null +++ b/_static/latex/preamble.tex @@ -0,0 +1,25 @@ +% 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} diff --git a/_static/latex/title.tex b/_static/latex/title.tex new file mode 100644 index 0000000000000000000000000000000000000000..b6b842995a9102e42dc92a41022a841b82d8d76d --- /dev/null +++ b/_static/latex/title.tex @@ -0,0 +1,43 @@ +% 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 diff --git a/conf.py b/conf.py index e0d561d9163e72da019c3629cfe7fc54d7d08ac8..a86d54b90a5eef5e9bd2ba791a8408026ad912e5 100644 --- a/conf.py +++ b/conf.py @@ -124,3 +124,25 @@ html_context = { "pages_slug": pages_slug, "docs_url": docs_url, } + +# -- Options for proposal PDF generation -- +latex_elements = { + "papersize": "a4paper", + "maketitle": open("_static/latex/title.tex").read(), + "preamble": open("_static/latex/preamble.tex").read(), + "sphinxsetup": ",".join( + ( + "verbatimwithframe=false", + "VerbatimColor={HTML}{f0f2f4}", + "InnerLinkColor={HTML}{2980b9}", + "warningBgColor={HTML}{e9a499}", + "warningborder=0pt", + r"HeaderFamily=\rmfamily\bfseries", + ) + ), +} +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 diff --git a/ideas/linux-kernel-improvements.rst b/ideas/linux-kernel-improvements.rst index 645b21793ab939bfc1430e35c45207da92b151c2..72b335bf7f87d09da25d0261447c4716c51a6732 100644 --- a/ideas/linux-kernel-improvements.rst +++ b/ideas/linux-kernel-improvements.rst @@ -7,7 +7,7 @@ Below are the projects that comes under linux kernel improvements category. .. card:: - :fab:`linux;pst-color-secondary` **BeagleBone Cape (add-on board) compatibility layer (BB-CCL)** + :fab:`linux;pst-color-secondary` **BeagleBone Cape (add-on board) compatibility layer (BB-CCL)** :bdg-danger:`High priority` :bdg-success:`Medium complexity` :bdg-danger-line:`Large size` ^^^^ - **Goal:** Update the cape compatibility layer for BeagleBone Black, AI-64, and newer boards to support more kernel versions. @@ -23,10 +23,13 @@ Below are the projects that comes under linux kernel improvements category. - `GSoC 2020 project page <https://elinux.org/BeagleBoard/GSoC/2020_Projects/Cape_Compatibility>`_ - `lorforlinux's GSoC project documentation website <https://lorforlinux.github.io/GSoC2020_BeagleBoard.org/>`_ - ++++ - :bdg-danger:`High priority` :bdg-success:`Medium complexity` :bdg-danger-line:`Large size` + .. button-link:: https://example.com + :color: secondary + :expand: + + :fab:`gitlab;pst-color-light` Discuss on forum .. card:: diff --git a/index.rst b/index.rst index 5e52d1cdc325a19d1b108479e9733b5bdbb988ff..ffbd798940651cde709e4cb28a9d14bd83183fe4 100644 --- a/index.rst +++ b/index.rst @@ -107,14 +107,8 @@ Work on awesome open source projects this summer with BeagleBoard.org! .. toctree:: :maxdepth: 2 :hidden: - :caption: Project Ideas ideas/index + proposals/index contrib/index - -.. toctree:: - :maxdepth: 2 - :hidden: - :caption: Past Projects - - Projects/index \ No newline at end of file + projects/index \ No newline at end of file diff --git a/Projects/2010.rst b/projects/2010.rst similarity index 100% rename from Projects/2010.rst rename to projects/2010.rst diff --git a/Projects/2013.rst b/projects/2013.rst similarity index 100% rename from Projects/2013.rst rename to projects/2013.rst diff --git a/Projects/2014.rst b/projects/2014.rst similarity index 100% rename from Projects/2014.rst rename to projects/2014.rst diff --git a/Projects/2015.rst b/projects/2015.rst similarity index 100% rename from Projects/2015.rst rename to projects/2015.rst diff --git a/Projects/2016.rst b/projects/2016.rst similarity index 100% rename from Projects/2016.rst rename to projects/2016.rst diff --git a/Projects/2017.rst b/projects/2017.rst similarity index 100% rename from Projects/2017.rst rename to projects/2017.rst diff --git a/Projects/2018.rst b/projects/2018.rst similarity index 100% rename from Projects/2018.rst rename to projects/2018.rst diff --git a/Projects/2019.rst b/projects/2019.rst similarity index 100% rename from Projects/2019.rst rename to projects/2019.rst diff --git a/Projects/2020.rst b/projects/2020.rst similarity index 100% rename from Projects/2020.rst rename to projects/2020.rst diff --git a/Projects/2021.rst b/projects/2021.rst similarity index 100% rename from Projects/2021.rst rename to projects/2021.rst diff --git a/Projects/2022.rst b/projects/2022.rst similarity index 100% rename from Projects/2022.rst rename to projects/2022.rst diff --git a/Projects/2023.rst b/projects/2023.rst similarity index 100% rename from Projects/2023.rst rename to projects/2023.rst diff --git a/Projects/index.rst b/projects/index.rst similarity index 100% rename from Projects/index.rst rename to projects/index.rst diff --git a/proposals/index.rst b/proposals/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..3cb1745c20c985ab05113f2593b1c76fd1825e33 --- /dev/null +++ b/proposals/index.rst @@ -0,0 +1,11 @@ +.. _proposals: + +Proposals +######### + + + +.. toctree:: + :hidden: + + template \ No newline at end of file diff --git a/proposals/template.rst b/proposals/template.rst new file mode 100644 index 0000000000000000000000000000000000000000..56cbce2e1abea748346a2a3186a9eb1173847da0 --- /dev/null +++ b/proposals/template.rst @@ -0,0 +1,95 @@ +.. _proposal_template: + +Proposal template +################# + +Introduction +************* + +Status +======= + +About +===== + +Project +******** + +Description +============ + +Software +========= + +Hardware +======== + + +Timeline +******** + +Community Bonding Period (May 1st - May 26th) +============================================== + +GSoC contributors get to know mentors, read documentation, get up to speed to begin working on their projects + +Introductory YouTube video (May 24th) +===================================== + +Coding begins (May 27th) +========================= + +Milestone #1 (June 10th) +========================== + +Milestone #2 (June 24th) +========================== + +Milestone #3 (July 8th) +======================= + +.. important:: + + **July 12 - 18:00 UTC:** Midterm evaluation deadline (standard coding period) + +Milestone #4 (July 22nd) +========================= + +Milestone #5 (Aug 5th) +======================= + +Milestone #6 (Aug 19th) +======================== + +Final YouTube video (Aug 22nd) +=============================== + +Final Submission (Aug 24nd) +============================ + +.. important:: + + **August 19 - 26 - 18:00 UTC:** Final week: GSoC contributors submit their final work + product and their final mentor evaluation (standard coding period) + + **August 26 - September 2 - 18:00 UTC:** Mentors submit final GSoC contributor + evaluations (standard coding period) + +Initial results (September 3) +============================= + +.. important:: + **September 3 - November 4:** GSoC contributors with extended timelines continue coding + + **November 4 - 18:00 UTC:** Final date for all GSoC contributors to submit their final work product and final evaluation + + **November 11 - 18:00 UTC:** Final date for mentors to submit evaluations for GSoC contributor projects with extended deadline + +Experience and approch +*********************** + +Contingency +=========== + +Benefit +======== \ No newline at end of file