openstack
/
oslosphinx
Code Issues Proposed changes

Support more notice blocks like important, tip and caution 

Sphinx supports various notice blocks but the oslosphinx theme
does support only warning and note. openstackdoctheme used by
openstack-manuals project supports 'important', 'tip' and 'caution'
blocks. It would be nice if oslosphinx support these notices.
It reduces confusions on contributors to both types of projects.

Change-Id: I3e1db551b05fa681520763c24e2576f9ad5379d8
This commit is contained in:
Akihiro Motoki 2016-09-15 19:39:26 +09:00
parent 5c765d5561
commit c6b55af713
3 changed files with 50 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/index.rst
View File

@ -20,6 +20,14 @@ Release Notes
history
Development
===========
.. toctree::
:maxdepth: 1
theme_check
Indices and tables
==================

25
doc/source/theme_check.rst Normal file
View File

@ -0,0 +1,25 @@
===========
Theme check
===========
This page is used to check the themes provided by oslosphinx.
.. note::
A comment with additional information that explains a part of the text.
.. important::
Something you must be aware of before proceeding.
.. tip::
An extra but helpful piece of practical advice.
.. Caution::
Helpful information that prevents the user from making mistakes.
.. Warning::
Critical information about the risk of data loss or security issues.

19
oslosphinx/theme/openstack/static/nature.css
View File

@ -188,8 +188,8 @@ div.highlight{
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
background-color: #edf2f7;
border: 1px solid #2a4e68;
}
div.seealso {
@ -206,6 +206,21 @@ div.warning {
border: 1px solid #f66;
}
div.important {
background-color: #feffbe;
border: 1px solid #d7aa16;
}
div.caution {
background-color: #eee;
border: 1px solid #ccc;
}
div.tip {
background-color: #eee;
border: 1px solid #ccc;
}
p.admonition-title {
display: inline;
}