Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • docs/docs.beagleboard.io
  • jkridner/docs
  • lorforlinux/docs.beagleboard.io
  • harshilbhatt2001/docs.beagleboard.io
  • Krishna_13/docs.beagleboard.io
  • gpioblink/docs.beagleboard.io
  • dhruvag2000/docs.beagleboard.io
  • jiande/docs.beagleboard.io
  • beagleplay/docs
  • beaglev-ahead/docs
  • sabeeh.khan14/docs.beagleboard.io
  • yoder/docs.beagleboard.io
  • jdneal/docs.beagleboard.io
  • ayush1325/docs.beagleboard.io
  • vishnumaiea/docs.beagleboard.io
  • andrei1998/docs-beagleboard-io-zephyr-demo
  • andrei1998/docs.beagleboard.io
  • nmenon/docs.beagleboard.io
  • epenguin/docs.beagleboard.io
  • paul_buxton/docs.beagleboard.io
  • anujdeshpande/docs.beagleboard.io
  • melta101/docs.beagleboard.io
  • krvprashanth/docs.beagleboard.io
  • samdai/docs.beagleboard.io
  • bustedwing1/docs.beagleboard.io
  • cshegedus/docs.beagleboard.io
  • wmat/docs.beagleboard.io
  • Roger18/docs.beagleboard.io
  • himanshuk/docs.beagleboard.io
  • vvaishak/docs.beagleboard.io
  • alecdenny/docs.beagleboard.io
  • san.s.kar03/docs.beagleboard.io
  • andrei1998/docs-beagleboard-io-fixes
  • SomeInterestingUserName/docs.beagleboard.io
  • edge-ai/docs
  • andrei1998/docs-beagleboard-io-rtc
  • devarsht/docs.beagleboard.io
  • andrei1998/docs-beagleboard-io-deepak-fork
  • superchamp234/docs.beagleboard.io
  • lranders/docs.beagleboard.io
  • kushalkr/docs.beagleboard.io
  • mkorpershoek/docs.beagleboard.io
  • prajnark/docs.beagleboard.io
  • touchhowling/docs.beagleboard.io
  • RobertCNelson/docs.beagleboard.io
  • Shankari02/docs.beagleboard.io
  • LucienMorey/docs.beagleboard.io
  • ketanthorat/docs.beagleboard.io
  • jjateen/docs.beagleboard.io
  • Whiz-Manas/mana-docs-beagleboard-io
  • beagley-ai/zephyr/docs.beagleboard.io
  • giuliomoro/docs.beagleboard.io
52 results
Show changes
Commits on Source (692)
Showing
with 258 additions and 45 deletions
image: beagle/sphinx-build-env:latest
image: registry.git.beagleboard.org/docs/sphinx-build-env:latest
variables:
GIT_SUBMODULE_STRATEGY: recursive
cache:
key: sphinx-build-env-docs-001
key: sphinx-build-env-docs-003
paths:
- .venv
- .cache
......@@ -45,7 +45,7 @@ docs:
- "build: [html]"
- "build: [pdf]"
tags:
- docs
- docker-amd64
script:
- ./gitlab-build.sh publish
artifacts:
......
[submodule "books/beaglebone-cookbook/code"]
path = books/beaglebone-cookbook/code
url = https://git.beagleboard.org/beagleboard/beaglebone-cookbook-code.git
url = https://openbeagle.org/beagleboard/beaglebone-cookbook-code.git
[submodule "books/pru-cookbook/code"]
path = books/pru-cookbook/code
url = https://git.beagleboard.org/beagleboard/pru-cookbook-code
url = https://openbeagle.org/beagleboard/pru-cookbook-code
[submodule "projects/librobotcontrol"]
path = projects/librobotcontrol
url = https://git.beagleboard.org/beagleboard/librobotcontrol
url = https://openbeagle.org/beagleboard/librobotcontrol
:orphan:
.. _not-found:
Document not found
##################
.. todo::
We need a 404 document to help people handle broken links (report, find, etc.).
......@@ -14,21 +14,21 @@ where to start then you can checkout our contribution documents to help you with
### Code of Conduct
This project and everyone participating in it is governed by the [BeagleBoard.org Code of Conduct](https://docs.beagleboard.org/latest/intro/contribution/index.html#code-of-conduct). By participating, you are expected to uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or contact one of the administrators on https://forum.beagleboard.org.
This project and everyone participating in it is governed by the [BeagleBoard.org Code of Conduct](https://docs.beagleboard.org/latest/intro/contribution/code-of-conduct.html). By participating, you are expected to uphold this code. Please report unacceptable behavior to [coc@bbb.io](mailto:coc@bbb.io) or contact one of the administrators on https://forum.beagleboard.org.
### Style and usage guidelines
If you are new to Sphinx, RST, or git then you can checkout out our [Style and usage guidelines](https://docs.beagleboard.org/latest/intro/contribution/index.html#style-and-usage-guidelines).
If you are new to Sphinx, RST, or git then you can checkout out our [How can I contribute? guide](https://docs.beagleboard.org/latest/intro/contribution/how.html).
See more at https://docs.beagleboard.org/en/latest/intro/contribution/.
See more at https://docs.beagleboard.org/latest/intro/contribution/.
### Forking the Project
You can [fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) this project repository to create and submit changes to the documentation. BeagleBoard documentation is generated using [**Sphinx** ](https://www.sphinx-doc.org/en/master/) documentation tool. Sphinx uses the [**reStructuredText**](https://docutils.sourceforge.io/rst.html) (.rst) markup language by default. Some files are also written in [**Markdown**](https://docs.gitlab.com/ee/user/markdown.html) (.md) format. GitLab can render previews for both RST and MD files. So if you do not want to use any external tools to edit the documentation, you can do that within your browser and use the `Preview` button in GitLab to view how the changes will actually look like.
You can [fork](https://openbeagle.org/help/user/project/repository/forking_workflow.md) this project repository to create and submit changes to the documentation. BeagleBoard documentation is generated using [**Sphinx** ](https://www.sphinx-doc.org/en/master/) documentation tool. Sphinx uses the [**reStructuredText**](https://docutils.sourceforge.io/rst.html) (.rst) markup language by default. Some files are also written in [**Markdown**](https://docs.gitlab.com/ee/user/markdown.html) (.md) format. GitLab can render previews for both RST and MD files. So if you do not want to use any external tools to edit the documentation, you can do that within your browser and use the `Preview` button in GitLab to view how the changes will actually look like.
#### Using A Browser
Using a browser is the easiest way to contribute to this project, if you are a beginner, or if your suggestions for changes are small. Though, some Git version control knowledge is preferrable. You can learn more about [Git and GitLab from here](https://docs.gitlab.com/ee/topics/git/).
Using a browser is the easiest way to contribute to this project, if you are a beginner, or if your suggestions for changes are small. Though, some Git version control knowledge is preferrable. You can learn more about [Git and GitLab from here](https://openbeagle.org/help/topics/git/index.md).
You can create a fork of this repository to your GitLab account using the `Forks` button found on the main page of the project. This will create a stand-alone copy of the repository for you to work with.
......@@ -65,4 +65,8 @@ VS Code is not limited to running from a folder as a workspace, or as a native a
## FAQ
* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq/19)
* [Frequently Asked Questions category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/faq)
## Feedback
* [Site Feedback category on the BeagleBoard.org Forum](https://forum.beagleboard.org/c/site-feedback)
VERSION_MAJOR = 1
VERSION_MINOR = 0
PATCHLEVEL =
VERSION_TWEAK =
EXTRAVERSION = wip
.wy-side-nav-search > a img.logo {
.wy-side-nav-search>a img.logo {
width: 340px;
height: 66px;
}
.rst-content div.figure, .rst-content figure {
.rst-content div.figure,
.rst-content figure {
text-align: center;
}
......@@ -36,7 +37,7 @@
background-color: #25282b;
}
.wy-nav-top{
.wy-nav-top {
background-color: #25282b;
background-color: #25282b;
}
......@@ -62,7 +63,7 @@
/* Force table content font-size in responsive tables to be 100%
* fixing larger font size for paragraphs in the kconfig tables */
.wy-table-responsive td p {
.wy-table-responsive td p {
font-size: 100%;
}
......@@ -74,6 +75,68 @@ span.strike {
overflow: auto;
}
/* Site horizontal spacing */
.bd-main .bd-content .bd-article-container {
max-width: 100%; /* default is 60em */
}
\ No newline at end of file
max-width: 120em;
/* default is 60em */
}
.bd-page-width {
max-width: 120rem;
/* default is 88rem */
}
/* Figure headerlink */
figure a.headerlink {
position: static;
}
/* Primary sidebar toggle button */
#pst-primary-sidebar.collapsed {
overflow: hidden;
padding: 0;
width: 0; /* Collapse the sidebar */
transition: none;
}
#pst-secondary-sidebar.collapsed {
overflow: hidden;
padding: 0;
width: 0; /* Collapse the sidebar */
transition: none;
}
#pst-secondary-sidebar {
padding-left: 0px;
}
/* Toggle button styles */
.sidebar-toggle-btn {
margin-top: 44px; /* Space between sidebar and button */
padding: 7px; /* Set padding for the button, horizontally more */
background-color: #F16321; /* Button background color */
color: white; /* Text color */
border: none; /* Remove border */
cursor: pointer; /* Pointer cursor on hover */
display: block; /* Ensure the button is block-level */
font-size: 20px; /* Adjust font size */
font-weight: bold; /* Bold text */
height: 40px; /* Set a fixed height for the button */
width: auto; /* Width based on content */
line-height: 20px; /* Vertically center the text */
}
#toggle-primary-sidebar.sidebar-toggle-btn{
border-radius: 0 5px 5px 0; /* Rounded corners */
}
#toggle-secondary-sidebar.sidebar-toggle-btn{
border-radius: 5px 0 0 5px; /* Rounded corners */
}
/* Optional: Adding a hover effect */
.sidebar-toggle-btn:hover {
background-color: #C7480D; /* Slightly darker blue on hover */
}
.. Production board images
.. Production board boot media
.. Created on: 2024-03-22
.. Updated on: 2024-03-24
.. Updated on: 2024-04-12
.. Add BeagleBone AI production image (Rev -)
.. Add BeagleBone Blue production iamge (Rev -)
.. Add BeagleV-Fire production image (Rev -)
.. Add BeagleBone AI Rev -
.. Add BeagleBone Blue Rev -
.. Add BeagleV-Fire Rev -
.. _BeaglePlay production image (Rev A2): https://www.beagleboard.org/distros/beagleplay-rev-a2
.. _BeaglePlay Rev A2: https://www.beagleboard.org/distros/beagleplay-rev-a2
.. _BeagleBone AI-64 production image (Rev B1): https://www.beagleboard.org/distros/beaglebone-ai-64-rev-b1
.. _BeagleBone AI-64 Rev B1: https://www.beagleboard.org/distros/beaglebone-ai-64-rev-b1
.. _BeagleBone Black production image (Rev C3a): https://www.beagleboard.org/distros/am3358-debian-10-3-2020-04-06-4gb-sd-iot
.. _BeagleBone Black Rev C3a: https://www.beagleboard.org/distros/am3358-debian-10-3-2020-04-06-4gb-sd-iot
.. _BeagleBone Black Industrial production image (Rev C3a): https://www.beagleboard.org/distros/am3358-debian-10-3-2020-04-06-4gb-sd-iot
.. _BeagleBone Black Industrial Rev C3a: https://www.beagleboard.org/distros/am3358-debian-10-3-2020-04-06-4gb-sd-iot
.. _BeagleV-Ahead production image (Rev 1.0): https://www.beagleboard.org/distros/beaglev-ahead-rev-1-0
.. _BeagleV-Ahead Rev 1.0: https://www.beagleboard.org/distros/beaglev-ahead-rev-1-0
.. _PocketBeagle production image (Rev Rev A2b): https://www.beagleboard.org/distros/am3358-debian-10-3-2020-04-06-4gb-sd-iot
.. _PocketBeagle Rev Rev A2b: https://www.beagleboard.org/distros/am3358-debian-10-3-2020-04-06-4gb-sd-iot
.. _BeagleConnect Freedom production iamge (Rev C7): https://www.beagleboard.org/distros/beagleconnect-freedom-rev-c7
.. _BeagleConnect Freedom Rev C7: https://www.beagleboard.org/distros/beagleconnect-freedom-rev-c7
......@@ -9,6 +9,8 @@
\usepackage{longtable}
\usepackage{fontspec}
\usepackage{comment}
\usepackage[maxfloats=256]{morefloats}
\maxdeadcycles=1000
\defaultfontfeatures{Mapping=tex-text,Scale=MatchLowercase}
\setmainfont{DejaVuSans}
\setmonofont{FreeMono}
......
{% extends "pydata_sphinx_theme/layout.html" %}
{% block extrahead %}
<script>
document.addEventListener("DOMContentLoaded", function () {
// The redirect_folders dictionary is passed from html_context
const redirectFolders = JSON.parse('{{ redirect_folders | tojson | safe }}');
// Get the current URL
let currentUrl = window.location.href;
// Flag to check if valid redirect is found
let redirectFound = false;
// Iterate over the redirect_folders key-value pairs
for (const [key, value] of Object.entries(redirectFolders)) {
if (currentUrl.includes("/" + key)) {
// Determine the replacement value
let replacement = value === "" ? "" : "/" + value;
// Create a new URL by replacing "/key" with the replacement value
let newUrl = currentUrl.replace("/" + key, replacement);
// Make an HTTP request to check if the new URL exists
fetch(newUrl, { method: "HEAD" })
.then(response => {
if (response.ok) {
// Valid redirect is found
redirectFound = true;
// Update the heading with the correct information
const headingElement = document.getElementById('pageHeading');
if (headingElement) {
headingElement.textContent = "Page Moved!";
}
// Update the message with the correct link
const redirectMessageElement = document.getElementById('redirectMessage');
if (redirectMessageElement) {
redirectMessageElement.innerHTML = `We found the correct page you are looking for <a href="${newUrl}" id="correctPageLink">here</a>.`;
}
document.getElementById('redirectInfo').style.display = "block";
// If the response is OK, show the modal and initiate the countdown
const redirectModal = new bootstrap.Modal(document.getElementById('redirectModal'), {
backdrop: 'static', // Prevents closing the modal by clicking outside
keyboard: false // Disables closing the modal with the keyboard
});
redirectModal.show();
let countdownValue = 5;
const countdownElement = document.getElementById('countdownNumber');
if (countdownElement) {
countdownElement.textContent = countdownValue;
}
// Variable to track if countdown should continue
let countdownActive = true;
// Countdown from 5 to 1
const countdownInterval = setInterval(() => {
if (!countdownActive) {
clearInterval(countdownInterval);
return;
}
countdownValue--;
if (countdownElement) {
countdownElement.textContent = countdownValue;
}
// When countdown reaches 1, redirect
if (countdownValue <= 1) {
clearInterval(countdownInterval);
window.location.href = newUrl;
}
}, 1000);
// Event listener for "Redirect Now" button
document.getElementById('redirectNow').addEventListener('click', () => {
window.location.href = newUrl;
});
// Event listener for "Cancel" button
document.getElementById('cancelRedirect').addEventListener('click', () => {
countdownActive = false;
clearInterval(countdownInterval);
});
// Event listener for "Close" button in the modal header
document.getElementById('closeRedirect').addEventListener('click', () => {
countdownActive = false;
clearInterval(countdownInterval);
});
} else {
// If the response is not OK, proceed to check other redirects
console.log(`No valid page found at ${newUrl}`);
}
})
.catch(error => {
console.error("Error checking the URL:", error);
});
break;
}
}
if (!redirectFound) {
// In case the link test doesn't include redirectFolders
const headingElement = document.getElementById('pageHeading');
if (headingElement) {
headingElement.textContent = "Page Not Found (404)";
}
document.getElementById('redirectInfo').style.display = "block";
}
});
</script>
{{ super() }}
{% endblock %}
{% block docs_body %}
<div class="document">
<h1 id="pageHeading">Page Loading....</h1> <!-- Default heading -->
<div id="redirectInfo" style="display: none;">
<p id="redirectMessage">Oops! The page you're looking for does not exist.</p>
<p>You can return to the <a href="{{ pathto(master_doc) }}">home page</a>.</p>
<p>If you believe this is a broken link, please <a data-bs-toggle="modal" data-bs-target="#feedbackModal"
href="#" onclick="getFeedbackButtonhref(this)">let us know</a>.</p>
</div>
</div>
<!-- Redirect Modal -->
<div class="modal fade" id="redirectModal" aria-labelledby="redirectModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg modal-dialog-centered">
<div class="modal-content">
<div class="modal-header">
<h5 class="modal-title m-0 text-dark" id="redirectModalLabel">Page Moved - Redirecting</h5>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"
id="closeRedirect"></button>
</div>
<div class="modal-body text-center">
<p>We have found the page you are looking for, redirecting in....</p>
<div class="countdown display-1 fw-bold" id="countdownNumber">5</div>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal"
id="cancelRedirect">Cancel</button>
<button type="button" class="btn btn-primary" id="redirectNow">Redirect Now</button>
</div>
</div>
</div>
</div>
{{ super() }}
{% endblock %}
\ No newline at end of file