blob: dbcc111844efa7df60602e44adcd9ee4264734b9 [file] [log] [blame]
Garret Kelly9eebde02019-10-22 15:36:49 -04001# Copyright lowRISC contributors.
2# Licensed under the Apache License, Version 2.0, see LICENSE for details.
3# SPDX-License-Identifier: Apache-2.0
4
5# CAUTION: Use util/build_docs.py to generate the documentation site. There
6# are pre-processing steps that are not yet integrated into the hugo-based
7# build.
8
9assetDir = "site/docs/assets"
10baseURL = "https://docs.opentitan.org"
11disablePathToLower = true
Garret Kelly7c0a8b02019-10-30 12:52:06 -040012disableLiveReload = true
Garret Kelly9eebde02019-10-22 15:36:49 -040013contentDir = "../.."
14resourceDir = "build/docs-resources"
15ignoreFiles = [
16 ".*\\.S$",
17 ".*\\.bin$",
18 ".*\\.c$",
Garret Kelly6c7f24a2019-11-01 16:21:52 -040019 ".*\\.cc$",
Eunchan Kim8e8634f2021-05-26 22:01:14 -070020 ".*\\.cmd$",
Garret Kelly9eebde02019-10-22 15:36:49 -040021 ".*\\.cfg$",
22 ".*\\.core$",
23 ".*\\.dat$",
Garret Kelly6c7f24a2019-11-01 16:21:52 -040024 ".*\\.do$",
25 ".*\\.el$",
Garret Kelly9eebde02019-10-22 15:36:49 -040026 ".*\\.f$",
27 ".*\\.h$",
28 ".*\\.hjson$",
29 ".*\\.ld$",
Garret Kelly6c7f24a2019-11-01 16:21:52 -040030 ".*\\.mak$",
31 ".*\\.md5$",
Garret Kelly9eebde02019-10-22 15:36:49 -040032 ".*\\.mk$",
Garret Kelly6c7f24a2019-11-01 16:21:52 -040033 ".*\\.mmi$",
Garret Kelly9eebde02019-10-22 15:36:49 -040034 ".*\\.o$",
Garret Kelly6c7f24a2019-11-01 16:21:52 -040035 ".*\\.patch$",
Garret Kelly9eebde02019-10-22 15:36:49 -040036 ".*\\.py$",
Garret Kelly6c7f24a2019-11-01 16:21:52 -040037 ".*\\.pyc$",
38 ".*\\.rsp$",
Garret Kelly9eebde02019-10-22 15:36:49 -040039 ".*\\.sh$",
40 ".*\\.sv$",
41 ".*\\.svh$",
42 ".*\\.tcl$",
43 ".*\\.tpl$",
44 ".*\\.txt$",
45 ".*\\.xdc$",
46 ".*\\.yml$",
Sam Elliott15cae7a2020-04-23 14:50:21 +010047 ".*\\.clang-format$",
Miguel Osorio1c8b4fd2022-06-30 21:37:44 -070048
49 # DO NOT remove README.md from this list. See issue #13345 for more details.
Miguel Osorio323bcb72022-06-23 13:29:01 -070050 ".*README.md",
Miguel Osorio1c8b4fd2022-06-30 21:37:44 -070051 ".*CONTRIBUTING.md",
52
Greg Chadwick1cb64732021-09-06 12:53:11 +010053 "/__pycache__/.*",
Drew Macrae51abd9f2021-12-07 14:54:24 +000054 "/bazel-.*/.*",
Greg Chadwick1cb64732021-09-06 12:53:11 +010055 "/build/.*",
Drew Macrae51abd9f2021-12-07 14:54:24 +000056 "/build-.*/.*",
Miguel Osorio40caa9e2021-05-27 21:45:20 -070057 "/ci/",
Greg Chadwick1cb64732021-09-06 12:53:11 +010058 "/hw/vendor/.*",
Philipp Wagner23555a62021-03-16 20:31:52 +000059 "/hw/ip_templates/.*",
Greg Chadwick1cb64732021-09-06 12:53:11 +010060 "/sw/vendor/.*",
Philipp Wagner2c0db502019-10-31 13:07:47 +000061 "/opentitan-docs/",
Philipp Wagner1b099b22019-10-31 13:01:08 +000062 "/scratch/",
Greg Chadwick1cb64732021-09-06 12:53:11 +010063 "/site/.*",
Sam Elliottb6745d32020-04-08 21:46:28 +010064 "/util/doxygen/",
Eunchan Kim8e8634f2021-05-26 22:01:14 -070065 ".*/jgproject/.*",
66 ".*/verdiLog/.*",
Garret Kelly9eebde02019-10-22 15:36:49 -040067 "Makefile$",
Tobias Wölfel15fde552020-02-26 09:39:47 +010068 "CLA",
69 "COMMITTERS",
Garret Kelly9eebde02019-10-22 15:36:49 -040070]
Garret Kelly9eebde02019-10-22 15:36:49 -040071disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"]
Garret Kellyda3e90d2019-11-04 14:06:12 -050072googleAnalytics = "UA-151030466-2"
Sam Elliottb6745d32020-04-08 21:46:28 +010073staticDir = [
74 # This is the generated software APIs
75 "build/docs-generated/sw/public-api",
76]
Garret Kelly9eebde02019-10-22 15:36:49 -040077
78[params]
79generatedRoot = "build/docs-generated"
Alex Bradbury3e76f782019-11-01 06:56:05 +000080
Tobias Wölfelba164902020-02-26 09:18:54 +010081[markup]
Tobias Wölfeld9f63e12020-06-04 13:20:13 +020082 [markup.highlight]
83 guessSyntax = true
84 noClasses = false
Tobias Wölfelba164902020-02-26 09:18:54 +010085 [markup.goldmark.renderer]
86 unsafe = true
87 [markup.tableOfContents]
88 startLevel = 1
89 endLevel = 2
90 ordered = false