softwaresaved / event-organisation-guide

The Event Organisation Guide (EOG). Contact: @shoaibsufi
https://event-organisation-guide.readthedocs.io/
Creative Commons Attribution 4.0 International
10 stars 5 forks source link

use rst directives for notes and tips #51

Open shoaibsufi opened 3 years ago

shoaibsufi commented 3 years ago

Describe the change being requested Consider user .. note::, ..tip:: directives to highlight notes and tips in the documentation

State the reason for the change To make things clearer in the next version

Describe the impact of the change on other parts of the SSI-EOG Will have to decide what is a tip vs a note

Describe any alternatives you have considered (if applicable) Leave it as is - which is ok - but anything that makes it clearer is good

Additional context some useful info at - https://github.com/sadielbartholomew/sphinx-from-scratch