| commit | cd57f86030653a2fdd38ae8062f2e9c6b4f95460 | [log] [tgz] |
|---|---|---|
| author | Philipp Wagner <phw@lowrisc.org> | Thu Oct 31 14:20:39 2019 +0000 |
| committer | Garret Kelly <Garret.Kelly@gmail.com> | Thu Oct 31 13:24:09 2019 -0400 |
| tree | c598394978342fb0f8cd8bb92954aa41cb8399b9 | |
| parent | 6add24193e541aaa8273ab5b99cb29eee507564a [diff] |
[hugo] Install hugo if not present Developers would like to have an easy way to preview the documentation. Since hugo is distributed as a static binary, we can simply download it and drop it into the build folder if needed. Implementation note: The curl/tar option isn't overly beautiful, but using Python to download and then calling tar didn't seem significantly nicer to invest too much time into it.
This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository.
The project contains comprehensive documentation of all IPs and tools. You can either access it online or build it locally by following the steps below.
Download and install hugo-extended.
Ensure that you have the required Python modules installed (to be executed in the repository root):
$ sudo apt install python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./util/build_docs.py --preview
This compiles the documentation into ./build/docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:1313.
Have a look at CONTRIBUTING for guidelines how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).