search

feelpp / angiotk

Virtual Angiography Toolkit
http://docs.feelpp.org/angiotk/0.1
Apache License 2.0
5 stars 0 forks source link

Fix format of angiotk documentation #29

Closed prudhomm closed 6 years ago

prudhomm commented 6 years ago

AngioTK is now in Antora system, see #28, which uses asciidoc as a format for documentation. However various adoc files are using markdown instead of asciidoc, please fix this

source code should use 

[source,<lang>]
----
----

Sectioning should use = instead of #

/cc @feelpp/angiotk

prudhomm commented 6 years ago

@francoisdh any news on this ?

francoisdh commented 6 years ago

I've struggled to install antora last friday, the errors you helped me solve by using nvmwere replaced by others. It turned out the xcode command line tools needed an update, and after this I was able to install antora. I thought I had a good basic understanding of antora, after having read the quickstart and angiotk's corresponding code... But I am currently reading the antora documentation and trying to understand why the playbook generation fails (error about ui.bundle.url...). I will update the documentation as soon as I can.

francoisdh commented 6 years ago

I forgot to say I finally managed to run antora to generate the doc - hence the referenced commit, in which I fixed the asciidoc format for all files and enhanced readability and eased maintenance (or so I think). I am now preparing the documentation overhaul. Maybe we can close this issue after the pull request gets accepted ?