Documentation: include common parts
In user-level how-tos, some parts are common for every motherboard, for example:
- get coreboot sources
- install dependencies
Repeat these steps in every user-level how-to¶
- Somebody have to keep them up to date
Give a links to separate pages¶
- I don't like to jump to different pages when whole documentation can fit into one page
Include from special pages, which are not rendered by self¶
Here I will try to find a way to include common parts.
Updated by Alexey Vazhnov almost 3 years ago
It is possible to ignore files (and to avoid errors "document isn't included in any toctree") by adding a path into
It is possible to include reStructuredText into markdown pages by:
```eval_rst .. include:: ../../_include/download_sources.rst `` `
But it looks impossible to import markdown parts into markdown pages with current Sphinx configuration.
mdinclude from m2r does that I need:
Note: do not use
.. include:: filedirective to include markdown file even if in the markdown file, please use
.. mdinclude:: fileinstead.
But the latest m2r version from Gentoo portage doesn't work for me:
AttributeError: 'str' object has no attribute 'supported'
so it is better to try m2r2.