commit | 24398ab6d55ac625597effe13d77f164215095dd | [log] [tgz] |
---|---|---|
author | Sam Elliott <selliott@lowrisc.org> | Fri Jul 17 17:02:05 2020 +0100 |
committer | Sam Elliott <sam@lenary.co.uk> | Mon Jul 20 10:31:55 2020 +0100 |
tree | b0d790cf9d3ab6987765c2af4bd1ce46ec5e9f1e | |
parent | 5cbdefab0b4a473940ca560807b8065f880dc764 [diff] |
[docs] Address Doc Building Issues Issues when building the SW API Doxygen docs were not being correctly propagated to fail the build. This commit contains two changes: - The first is to ensure we `set -e` in the docs CI bash script, so that if the `build_docs.py` errors, the build fails. - The second is to make the process which extracts information from the Doxygen XML dump more robust to failures - returning empty strings when information is not available rather than throwing exceptions. Closes #2813 Signed-off-by: Sam Elliott <selliott@lowrisc.org>
OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.
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. It exists to enable collaboration across partners participating in the OpenTitan project.
The project contains comprehensive documentation of all IPs and tools. You can access it online at docs.opentitan.org.
Have a look at CONTRIBUTING for guidelines on 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).