https://github.com/linaro/ledge-doc
https://github.com/linaro/ledge-doc
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/linaro/ledge-doc
- Owner: Linaro
- License: cc-by-sa-4.0
- Created: 2020-02-17T09:11:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-28T10:20:54.000Z (about 5 years ago)
- Last Synced: 2025-01-17T21:30:12.561Z (over 1 year ago)
- Language: PostScript
- Size: 589 KB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
####################################################
Linaro EDGE (LEDGE) reference platform documentation
####################################################
The LEDGE documentation describes instructions to build, install
and use varios features included in LEDGE linux reference platform.
Contributing
============
Anyone may contribute to LEDGE doc. Discussion is on the
team-ledge@linaro.org mailing list, or linaro-ledge irc channel at
freenode.
Build Instructions
==================
Requirements
^^^^^^^^^^^^
* Sphinx version 1.5 or later: http://sphinx-doc.org/en/master/contents.html
* LaTeX (and pdflatex, and various LaTeX packages)
On Debian and Ubuntu
^^^^^^^^^^^^^^^^^^^^
::
# apt-get install python-sphinx texlive texlive-latex-extra libalgorithm-diff-perl \
texlive-humanities texlive-generic-recommended texlive-generic-extra \
latexmk
If the version of python-sphinx installed is too old, then an additional
new version can be installed with the Python package installer::
$ apt-get install python-pip
$ pip install --user --upgrade Sphinx
$ export SPHINXBUILD=~/.local/bin/sphinx-build
Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then follow Make commands below
On Fedora
^^^^^^^^^
::
# dnf install python2-sphinx texlive texlive-capt-of texlive-draftwatermark \
texlive-fncychap texlive-framed texlive-needspace \
texlive-tabulary texlive-titlesec texlive-upquote \
texlive-wrapfig
It is also possible to use python3-sphinx; this requires
SPHINXBUILD=sphinx-build-3 to be passed on the Make command line.
On Mac OS X
^^^^^^^^^^^
* Install MacTeX_
* Install pip if you do not have it::
$ sudo easy_install pip
* Install Sphinx::
$ pip install --user --upgrade Sphinx
.. _MacTeX: http://tug.org/mactex
Make Targets
^^^^^^^^^^^^
To generate PDF::
$ make latexpdf
To generate hierarchy of HTML pages::
$ make html
To generate a single HTML page::
$ make singlehtml
Output goes in `./build` subdirectory.
License
=======
International License (CC-BY-SA-4.0). To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
Contributions are accepted under the same with sign-off under the Developer's
Certificate of Origin. For more on contributing to EBBR, see CONTRIBUTING.rst_.
A copy of the license is included in the LICENSE_ file.
.. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png
:target: http://creativecommons.org/licenses/by-sa/4.0/
:alt: Creative Commons License
.. _CONTRIBUTING.rst: ./CONTRIBUTING.rst
.. _LICENSE: ./LICENSE
Writers Guide
=============
All documentation in this repository uses reStructuredText_ markup
with Sphinx_ extensions.
All files in this project must include the relevant SPDX license identifier
tag. Generally this means each ``.rst`` file should include the line
``.. SPDX-License-Identifier: CC-BY-SA-4.0``
.. _reStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickref.html
.. _Sphinx: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html