# Copyright lowRISC contributors. | |
# Licensed under the Apache License, Version 2.0, see LICENSE for details. | |
# SPDX-License-Identifier: Apache-2.0 | |
# CAUTION: Use util/build_docs.py to generate the documentation site. There | |
# are pre-processing steps that are not yet integrated into the hugo-based | |
# build. | |
assetDir = "site/docs/assets" | |
baseURL = "https://docs.opentitan.org" | |
disablePathToLower = true | |
disableLiveReload = true | |
contentDir = "../.." | |
resourceDir = "build/docs-resources" | |
ignoreFiles = [ | |
".*\\.S$", | |
".*\\.bin$", | |
".*\\.c$", | |
".*\\.cc$", | |
".*\\.cmd$", | |
".*\\.cfg$", | |
".*\\.core$", | |
".*\\.dat$", | |
".*\\.do$", | |
".*\\.el$", | |
".*\\.f$", | |
".*\\.h$", | |
".*\\.hjson$", | |
".*\\.ld$", | |
".*\\.mak$", | |
".*\\.md5$", | |
".*\\.mk$", | |
".*\\.mmi$", | |
".*\\.o$", | |
".*\\.patch$", | |
".*\\.py$", | |
".*\\.pyc$", | |
".*\\.rsp$", | |
".*\\.sh$", | |
".*\\.sv$", | |
".*\\.svh$", | |
".*\\.tcl$", | |
".*\\.tpl$", | |
".*\\.txt$", | |
".*\\.xdc$", | |
".*\\.yml$", | |
".*\\.clang-format$", | |
# DO NOT remove README.md from this list. See issue #13345 for more details. | |
".*README.md", | |
".*CONTRIBUTING.md", | |
"/__pycache__/.*", | |
"/bazel-.*/.*", | |
"/build/.*", | |
"/build-.*/.*", | |
"/ci/", | |
"/hw/vendor/.*", | |
"/hw/ip_templates/.*", | |
"/sw/vendor/.*", | |
"/opentitan-docs/", | |
"/scratch/", | |
"/site/.*", | |
"/util/doxygen/", | |
".*/jgproject/.*", | |
".*/verdiLog/.*", | |
"Makefile$", | |
"CLA", | |
"COMMITTERS", | |
] | |
disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"] | |
googleAnalytics = "UA-151030466-2" | |
staticDir = [ | |
# This is the generated software APIs | |
"build/docs-generated/sw/public-api", | |
] | |
[params] | |
generatedRoot = "build/docs-generated" | |
[markup] | |
[markup.highlight] | |
guessSyntax = true | |
noClasses = false | |
[markup.goldmark.renderer] | |
unsafe = true | |
[markup.tableOfContents] | |
startLevel = 1 | |
endLevel = 2 | |
ordered = false |