Open fititnt opened 4 years ago
Oh f**k me.
Rst + Sphinx actually is more complicated sophisticated than seems at first if I want some customization. I will finish this just because already started. And them implement on new projects.
This thing even allow by default export PDF and ePUB from the documentation.
Now I can understand a bit more the feel I hear from another Brazilian automation expert about be an markdown/yaml specialist in a non-ironical way.
At the https://github.com/fititnt/ansible-syntactic-sugar (older name: ap-application-load-balancer-extras) we're making some tests with a more robust way to render documentation using Sphinix (http://www.sphinx-doc.org) and hosting direct on Read The Docs (https://readthedocs.org/) instead of plain GitHub pages.
Depending of the results, the documentation of AP-ALB will use this new format. And the reasoning behind this is not only because of the embebed searching engine (and then even possibility to have several versions of the documentation enabled at same time) but also that, at least for more complex projects, it seems that using this method to document may actually worth the effort to learn a full documentation stack.