Guidelines for reusing/including content

tarantool / doc

Tarantool documentation

https://www.tarantool.io/en/doc/

Other

15 stars 43 forks source link

Open NickVolynkin opened 3 years ago

NickVolynkin commented 3 years ago

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 _includes directory
conf.py → exclude_pattern variable
rst_prolog, rst_epilog
what happens with the localization

Totktonada commented 3 years ago

Is it regarding modules, connectors and so on? It would be nice to have such guidelines.

NickVolynkin commented 3 years ago

@Totktonada the guide about including sub-projects is already in progress, you're welcome to give your feedback. #1763