diff --git a/docgen/pom.xml b/docgen/pom.xml index cd1fb7df..a34f56da 100644 --- a/docgen/pom.xml +++ b/docgen/pom.xml @@ -149,7 +149,7 @@ -bug_patterns=${basedir}/../error-prone-contrib/target/generated-sources/annotations/bugPatterns.txt -docs_repository=${basedir}/target/generated-wiki/ - -explanations=${basedir}/../docs/bugpattern-temp/ + -explanations=${basedir}/../docs/bugpatterns/ diff --git a/docgen/src/main/java/com/google/errorprone/resources/bugpattern.mustache b/docgen/src/main/java/com/google/errorprone/resources/bugpattern.mustache index dab54694..467af33a 100644 --- a/docgen/src/main/java/com/google/errorprone/resources/bugpattern.mustache +++ b/docgen/src/main/java/com/google/errorprone/resources/bugpattern.mustache @@ -13,8 +13,12 @@ To make changes, edit the @BugPattern annotation or the explanation in docs/bugp {{{severity}}} {{{tags}}} + +{: .summary } {{{summary}}} +{{{explanation}}} + {{#suppression}} ## Suppression {{{suppression}}} @@ -47,5 +51,3 @@ To make changes, edit the @BugPattern annotation or the explanation in docs/bugp - - diff --git a/generate-docs.sh b/generate-docs.sh index af3d90b4..17eee917 100755 --- a/generate-docs.sh +++ b/generate-docs.sh @@ -47,7 +47,7 @@ generate_bugpattern_docs() { # This will create markdown files for each bug pattern in `docgen/target/generated-wiki/bugpatterns` mvn -P run-annotation-processor compile site -Dverification.skip - cp -R docgen/target/generated-wiki/bugpatterns/ website/ + cp -r docgen/target/generated-wiki/bugpatterns/*.md website/bugpatterns } generate_refaster_docs() { diff --git a/website/_config.yml b/website/_config.yml index f561ca67..d80d7813 100644 --- a/website/_config.yml +++ b/website/_config.yml @@ -23,6 +23,14 @@ permalink: pretty # Use /doc/ vs. /doc.html search_enabled: true heading_anchors: true +callouts: + summary: + title: Summary + color: blue + warning: + title: Warning + color: red + nav_external_links: - title: Error Prone Support on GitHub url: https://github.com/PicnicSupermarket/error-prone-support