← Back to team overview

widelands-dev team mailing list archive

Re: [Merge] lp:~widelands-dev/widelands/document_worker_program into lp:widelands

 

For code examples there should be either a highlight directive used or the code-block directive. So comments are shown properly and some keywords in the comments (e.g.: and, or) are shown correctly.

See: http://build-me-the-docs-please.readthedocs.io/en/latest/Using_Sphinx/ShowingCodeExamplesInSphinx.html

If we are using only code examples in language lua, we could define the config var 'highlight_language'. See:

https://www.sphinx-doc.org/en/stable/config.html#confval-highlight_language

This has to be set in doc/sphinx/source/conf.py

One inline comment :-)
-- 
https://code.launchpad.net/~widelands-dev/widelands/document_worker_program/+merge/329696
Your team Widelands Developers is requested to review the proposed merge of lp:~widelands-dev/widelands/document_worker_program into lp:widelands.


References