Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit a4babdea authored by Deepak Khatri's avatar Deepak Khatri :dog:
Browse files

Add build instruction in contribution guide

parent 9268590a
No related merge requests found
......@@ -26,6 +26,7 @@ author = 'BeagleBoard.org'
extensions = [
"sphinx_design",
"sphinxcontrib.youtube",
"sphinx_copybutton"
]
templates_path = ['_templates']
......
......@@ -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
*****************
......
......@@ -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
File mode changed from 100644 to 100755
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment