From a4babdea7e8c38af6a8ce36f029b3e07f03c93e0 Mon Sep 17 00:00:00 2001
From: Deepak Khatri <deepaklorkhatri7@gmail.com>
Date: Sun, 4 Feb 2024 19:18:43 +0530
Subject: [PATCH] Add build instruction in contribution guide
---
conf.py | 1 +
guides/contrib.rst | 13 +++++++++++++
requirements.txt | 1 +
venv-build-env.sh | 0
4 files changed, 15 insertions(+)
mode change 100644 => 100755 venv-build-env.sh
diff --git a/conf.py b/conf.py
index e13989d..6c5bccf 100644
--- a/conf.py
+++ b/conf.py
@@ -26,6 +26,7 @@ author = 'BeagleBoard.org'
extensions = [
"sphinx_design",
"sphinxcontrib.youtube",
+ "sphinx_copybutton"
]
templates_path = ['_templates']
diff --git a/guides/contrib.rst b/guides/contrib.rst
index 188038a..6e7544a 100644
--- a/guides/contrib.rst
+++ b/guides/contrib.rst
@@ -11,6 +11,19 @@ simple steps provided below.
.. note:: `OpenBeagle <https://openbeagle.org/>`_ is a self hosted instance of open source program called `GitLab <https://about.gitlab.com/>`_.
+.. tip:: If you want to build on your local machine we have added ``venv-build-env.sh`` and ``requirements.txt``
+ to help you setup sphinx and all the other dependencies. Execute these commands in your terminal,
+
+ .. code:: shell
+
+ chmod +x venv-build-env.sh
+
+ .. code:: shell
+
+ make livehtml
+
+ Now, you can open `http://127.0.0.1:8000 <http://127.0.0.1:8000>`_ on any browser to see the rendered HTML with live updates.
+
Fork the project
*****************
diff --git a/requirements.txt b/requirements.txt
index 22d2b2e..4e1bfed 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -31,3 +31,4 @@ sphinxcontrib-youtube==1.4.1
tornado==6.4
typing_extensions==4.9.0
urllib3==2.2.0
+sphinx-copybutton==0.5.2
diff --git a/venv-build-env.sh b/venv-build-env.sh
old mode 100644
new mode 100755
--
GitLab