Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 1 | # 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 | |
| 9 | assetDir = "site/docs/assets" |
| 10 | baseURL = "https://docs.opentitan.org" |
| 11 | disablePathToLower = true |
Garret Kelly | 7c0a8b0 | 2019-10-30 12:52:06 -0400 | [diff] [blame] | 12 | disableLiveReload = true |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 13 | contentDir = "../.." |
| 14 | resourceDir = "build/docs-resources" |
| 15 | ignoreFiles = [ |
| 16 | ".*\\.S$", |
| 17 | ".*\\.bin$", |
| 18 | ".*\\.c$", |
Garret Kelly | 6c7f24a | 2019-11-01 16:21:52 -0400 | [diff] [blame] | 19 | ".*\\.cc$", |
Eunchan Kim | 8e8634f | 2021-05-26 22:01:14 -0700 | [diff] [blame] | 20 | ".*\\.cmd$", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 21 | ".*\\.cfg$", |
| 22 | ".*\\.core$", |
| 23 | ".*\\.dat$", |
Garret Kelly | 6c7f24a | 2019-11-01 16:21:52 -0400 | [diff] [blame] | 24 | ".*\\.do$", |
| 25 | ".*\\.el$", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 26 | ".*\\.f$", |
| 27 | ".*\\.h$", |
| 28 | ".*\\.hjson$", |
| 29 | ".*\\.ld$", |
Garret Kelly | 6c7f24a | 2019-11-01 16:21:52 -0400 | [diff] [blame] | 30 | ".*\\.mak$", |
| 31 | ".*\\.md5$", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 32 | ".*\\.mk$", |
Garret Kelly | 6c7f24a | 2019-11-01 16:21:52 -0400 | [diff] [blame] | 33 | ".*\\.mmi$", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 34 | ".*\\.o$", |
Garret Kelly | 6c7f24a | 2019-11-01 16:21:52 -0400 | [diff] [blame] | 35 | ".*\\.patch$", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 36 | ".*\\.py$", |
Garret Kelly | 6c7f24a | 2019-11-01 16:21:52 -0400 | [diff] [blame] | 37 | ".*\\.pyc$", |
| 38 | ".*\\.rsp$", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 39 | ".*\\.sh$", |
| 40 | ".*\\.sv$", |
| 41 | ".*\\.svh$", |
| 42 | ".*\\.tcl$", |
| 43 | ".*\\.tpl$", |
| 44 | ".*\\.txt$", |
| 45 | ".*\\.xdc$", |
| 46 | ".*\\.yml$", |
Sam Elliott | 15cae7a | 2020-04-23 14:50:21 +0100 | [diff] [blame] | 47 | ".*\\.clang-format$", |
Miguel Osorio | 1c8b4fd | 2022-06-30 21:37:44 -0700 | [diff] [blame] | 48 | |
| 49 | # DO NOT remove README.md from this list. See issue #13345 for more details. |
Miguel Osorio | 323bcb7 | 2022-06-23 13:29:01 -0700 | [diff] [blame] | 50 | ".*README.md", |
Miguel Osorio | 1c8b4fd | 2022-06-30 21:37:44 -0700 | [diff] [blame] | 51 | ".*CONTRIBUTING.md", |
| 52 | |
Greg Chadwick | 1cb6473 | 2021-09-06 12:53:11 +0100 | [diff] [blame] | 53 | "/__pycache__/.*", |
Drew Macrae | 51abd9f | 2021-12-07 14:54:24 +0000 | [diff] [blame] | 54 | "/bazel-.*/.*", |
Greg Chadwick | 1cb6473 | 2021-09-06 12:53:11 +0100 | [diff] [blame] | 55 | "/build/.*", |
Drew Macrae | 51abd9f | 2021-12-07 14:54:24 +0000 | [diff] [blame] | 56 | "/build-.*/.*", |
Miguel Osorio | 40caa9e | 2021-05-27 21:45:20 -0700 | [diff] [blame] | 57 | "/ci/", |
Greg Chadwick | 1cb6473 | 2021-09-06 12:53:11 +0100 | [diff] [blame] | 58 | "/hw/vendor/.*", |
Philipp Wagner | 23555a6 | 2021-03-16 20:31:52 +0000 | [diff] [blame] | 59 | "/hw/ip_templates/.*", |
Greg Chadwick | 1cb6473 | 2021-09-06 12:53:11 +0100 | [diff] [blame] | 60 | "/sw/vendor/.*", |
Philipp Wagner | 2c0db50 | 2019-10-31 13:07:47 +0000 | [diff] [blame] | 61 | "/opentitan-docs/", |
Philipp Wagner | 1b099b2 | 2019-10-31 13:01:08 +0000 | [diff] [blame] | 62 | "/scratch/", |
Greg Chadwick | 1cb6473 | 2021-09-06 12:53:11 +0100 | [diff] [blame] | 63 | "/site/.*", |
Sam Elliott | b6745d3 | 2020-04-08 21:46:28 +0100 | [diff] [blame] | 64 | "/util/doxygen/", |
Eunchan Kim | 8e8634f | 2021-05-26 22:01:14 -0700 | [diff] [blame] | 65 | ".*/jgproject/.*", |
| 66 | ".*/verdiLog/.*", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 67 | "Makefile$", |
Tobias Wölfel | 15fde55 | 2020-02-26 09:39:47 +0100 | [diff] [blame] | 68 | "CLA", |
| 69 | "COMMITTERS", |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 70 | ] |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 71 | disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"] |
Garret Kelly | da3e90d | 2019-11-04 14:06:12 -0500 | [diff] [blame] | 72 | googleAnalytics = "UA-151030466-2" |
Sam Elliott | b6745d3 | 2020-04-08 21:46:28 +0100 | [diff] [blame] | 73 | staticDir = [ |
| 74 | # This is the generated software APIs |
| 75 | "build/docs-generated/sw/public-api", |
| 76 | ] |
Garret Kelly | 9eebde0 | 2019-10-22 15:36:49 -0400 | [diff] [blame] | 77 | |
| 78 | [params] |
| 79 | generatedRoot = "build/docs-generated" |
Alex Bradbury | 3e76f78 | 2019-11-01 06:56:05 +0000 | [diff] [blame] | 80 | |
Tobias Wölfel | ba16490 | 2020-02-26 09:18:54 +0100 | [diff] [blame] | 81 | [markup] |
Tobias Wölfel | d9f63e1 | 2020-06-04 13:20:13 +0200 | [diff] [blame] | 82 | [markup.highlight] |
| 83 | guessSyntax = true |
| 84 | noClasses = false |
Tobias Wölfel | ba16490 | 2020-02-26 09:18:54 +0100 | [diff] [blame] | 85 | [markup.goldmark.renderer] |
| 86 | unsafe = true |
| 87 | [markup.tableOfContents] |
| 88 | startLevel = 1 |
| 89 | endLevel = 2 |
| 90 | ordered = false |