... if there's no policy of having everything in the ReST files. If not, includes would minimise the risk of code files and doc files being out of sync. And the ReST include directive has many options to pick only what you want, if you don't want to shoe the entire file. In the simplest case an include looks like this:
... if there's no policy of having everything in the ReST files. If not,
include
s would minimise the risk of code files and doc files being out of sync. And the ReSTinclude
directive has many options to pick only what you want, if you don't want to shoe the entire file. In the simplest case an include looks like this:See http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment