percursoaleatorio / build-me-the-docs-please Goto Github PK

The section on http://build-me-the-docs-please.readthedocs.io/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html#literalinclude-directive includes a mistake, in my mind:

The source text is

Instead of using line numbers (which can change), it is possible to use the options :start-after and :end-before: that search the included file for lines containing the specified text. For example:

Starting after "Instead of using" and ending before "For example" should reduce the text to

line numbers (which can change), it is possible to use the options :start-after and :end-before: that search the included file for lines containing the specified text.

ReadTheDocs does NOT support plantUML. It's Dockerfile (14.04) shows there is not java (sic)

So, the file UsingGraphicsAndDiagramsInSphinx.rst is a bit misleading; as if it would be possible on RTfD...

Especially line 144

plantuml = 'java -jar ../utils/plantum.jar'

Which seams to suggest that storing the JAR-file with (git/ht) version-controll can help, is misleading
(It DID tricked in a class of mine) .
Or plain wrong, as I see it (as storing the jar in VC is mostly not a good idea)

Also, in the general, this document read as if the images are generated by the server, whereas study the actual rest-souces shown the are just uploaded.
Please add a note about that!

Note: I would love to have plantUML support on RTfD. Or, a extension on the plantUML-extension to have "uploaded" images to RTfD "automagical", as long the former is not possible.
But plz, do not suggest this works out of the box.. _-Thanks

Is this message from the docs still valid?

Due to current (2013.10) compatibility issues with PlantUML, it may be preferable to install GraphViz > 2.28 instead.