New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use rst directives for notes and tips #51

Open

shoaibsufi opened this issue Nov 3, 2020 · 0 comments

Contributor

shoaibsufi commented Nov 3, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment