Skip to content
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.

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

Fix admonitions styling and spacing #172

Merged
merged 1 commit into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 68 additions & 1 deletion docs/test1.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,71 @@
Test 1
======

A bunch of words.
A bunch of words.

.. note::

This is how an admonition with multiple paragraphs looks like.

It can include many words.

There is also some text between admonitions.

.. warning::

* How is the padding in this list?
* Is it consistent?
* Does it look good with other elements?

.. attention::

Keep track of spacing and margins in admonitions.

* This is how they look like;
* Rely on upstream as much as possible.

And this is how an admonition with a title looks like:

.. admonition:: You can use titles!

Sometimes they are helpful.

Admonition colors
-----------------

.. attention::

This is an attention admonition.

.. caution::

This is a caution admonition.

.. warning::

This is a warning admonition.

.. danger::

This is a danger admonition.

.. error::

This is an error admonition.

.. hint::

This is a hint admonition.

.. tip::

This is a tip admonition.

.. important::

This is an important admonition.

.. note::

This is a note admonition.

Loading