Skip to content

Commit

Permalink
Switch Python APM Agent docs to Asciidoctor (#723)
Browse files Browse the repository at this point in the history
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 `<p></p>` 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.
  • Loading branch information
nik9000 authored Mar 18, 2019
1 parent d11c586 commit 99caf9e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,7 @@ contents:
tags: APM Python Agent/Reference
subject: APM
chunk: 1
asciidoctor: true
sources:
-
repo: apm-agent-python
Expand Down
2 changes: 1 addition & 1 deletion doc_build_aliases.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 --asciidoctor --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'

Expand Down

0 comments on commit 99caf9e

Please sign in to comment.