Guidelines for reusing/including content #1817
Description
How to include/reuse content in the documentation pages:
- including rST files with
include - including code examples with
literalinclude, setting the correct code highlighing - indentation, headings, reference labels
- put included files in the
_includesdirectory conf.py→exclude_patternvariablerst_prolog,rst_epilog- what happens with the localization
Metadata
Metadata
Assignees
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Participants
Activity
Totktonada commentedon Feb 10, 2021
Is it regarding modules, connectors and so on? It would be nice to have such guidelines.
NickVolynkin commentedon Feb 10, 2021
@Totktonada the guide about including sub-projects is already in progress, you're welcome to give your feedback. #1763
[-]Guidelines for reusing/including content[/-][+][20pt] Guidelines for reusing/including content[/+][-][20pt] Guidelines for reusing/including content[/-][+][24pt] Guidelines for reusing/including content[/+][-][24pt] Guidelines for reusing/including content[/-][+][16pt] Guidelines for reusing/including content[/+][-][16pt] Guidelines for reusing/including content[/-][+][5pt] Guidelines for reusing/including content[/+][-][5pt] Guidelines for reusing/including content[/-][+]Guidelines for reusing/including content[/+]