From 181dac622b36f8d02f1c0bd3132cc41a0b603461 Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Fri, 15 Mar 2019 11:59:55 -0400 Subject: [PATCH] Switch Python APM Agent docs to Asciidoctor Switches the core of the docs generation pipeline from the no-longer-maintained AsciiDoc project to the actively-maintained Asciidoctor project. The HTML that it produces isn't 100% the same but it looks to only differ in three ways: 1. Spacing that the browser will ignore anyway. 2. AsciiDoc was producing `

` inside of empty table cells. Asciidoctor does not. 3. In the 1.x docs there are some attribute references that do not resolve and they are rendered differently by Asciidoctor. Either way, they should probably be fixed in the 1.x branch of the docs. --- conf.yaml | 1 + doc_build_aliases.sh | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index 10522e8e2e3f1..4af974382ead0 100644 --- a/conf.yaml +++ b/conf.yaml @@ -891,6 +891,7 @@ contents: tags: APM Python Agent/Reference subject: APM chunk: 1 + asciidoctor: true sources: - repo: apm-agent-python diff --git a/doc_build_aliases.sh b/doc_build_aliases.sh index 1ca92ece0021b..fafa602c8ee4d 100644 --- a/doc_build_aliases.sh +++ b/doc_build_aliases.sh @@ -84,7 +84,7 @@ alias docbldamr='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/apm-server/docs/in alias docbldamn='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/apm-agent-nodejs/docs/index.asciidoc --chunk 1' -alias docbldamp='$GIT_HOME/docs/build_docs.pl --doc $GIT_HOME/apm-agent-python/docs/index.asciidoc --chunk 1' +alias docbldamp='$GIT_HOME/docs/build_docs --asciidoctor --doc $GIT_HOME/apm-agent-python/docs/index.asciidoc --chunk 1' alias docbldamry='$GIT_HOME/docs/build_docs --asciidoctor --doc $GIT_HOME/apm-agent-ruby/docs/index.asciidoc --chunk 1'