diff --git a/conf.py b/conf.py index e13989d59e9cc7ee1ea51b9c310f5a781e2f7748..6c5bccfa2cd2945f7924e9f0d781c9e15ea51179 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 188038a6b8cb6c0abcec92a7907b99c8feefc37c..6e7544ab12861cf5923359b20b5c3480ebd84205 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 22d2b2e6190b1be8bb56716492ee00108d23590c..4e1bfed0d810e91c63794d362224d758c66486fc 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