Sample Document to Check Sphinx, tex, etc. Install

Chris Johns chrisj at rtems.org
Wed Feb 22 21:51:08 UTC 2017


On 23/02/2017 01:16, Joel Sherrill wrote:
> I have been concerned that there is no easy way to know that
> the host has the complete toolset to build the rtems documentation.
> I know we are trying to catch things with waf but I was wondering
> about a short document that just does things that can be quickly
> checked for correctness.  Examples of:
>
> + math formula
> + citation
> + code example
> + ???
>
> Otherwise, to be confident, I have to know where to look in the
> various documents to find examples of things that can break.

Have you looked in the top level README.txt and the Documentation 
Standard section? I documented a number of the features I used. It may 
need updating.

There is no template for a directive and more could be added. That 
document is actually in ReST format or is close to it.

> This way we can provide a short document and a pre-formatted
> PDF as a reference.

Chris



More information about the devel mailing list