diff --git a/docs/readthedocs/source/_static/css/custom.css b/docs/readthedocs/source/_static/css/custom.css index e6ca444e..18f909b1 100644 --- a/docs/readthedocs/source/_static/css/custom.css +++ b/docs/readthedocs/source/_static/css/custom.css @@ -91,4 +91,9 @@ footer.bd-footer{ /* the margin height is just the height of original footer, to avoid content overlapping */ .bd-footer-article { margin-bottom: 5rem; +} + +/* for tables in documentation guides, vertically center rows */ +.bigdl-documentation-guide-tables td{ + vertical-align: middle; } \ No newline at end of file diff --git a/docs/readthedocs/source/_templates/sidebar_quicklinks.html b/docs/readthedocs/source/_templates/sidebar_quicklinks.html index 87f723d2..e85e6501 100644 --- a/docs/readthedocs/source/_templates/sidebar_quicklinks.html +++ b/docs/readthedocs/source/_templates/sidebar_quicklinks.html @@ -4,8 +4,8 @@
| reStructuredText | CommonMark | |
|---|---|---|
| Inline code | ++ +```rst +``inline code`` +``` + | ++ +```md +`inline code` +``` + + |
| Hyperlinks | +
+
+```rst
+`Relative link text |
++ +```md +[Relative link text](relatve/path/to/the/file) +[Absolute link text](https://www.example.com/) +``` + + |
| Italic | ++ +```rst +`italicized text` +*italicized text* +``` + | ++ +```md +*italicized text* + +``` + + |
| Italic & bold | ++ +Not supported, needed help with css + + | ++ +```md +***italicized & bold text*** +``` + + |
| Headers | ++ +```rst +Header Level 1 +========================= + +Header Level 2 +------------------------- + +Header Level 3 +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Header Level 4 +^^^^^^^^^^^^^^^^^^^^^^^^^ +``` + + | ++ +Note that the underline symbols should be at least as long as the header texts. + +Also, **we do not expect maually-added styles to headers.** + +You could refer [here](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections) for more information on reStructuredText sections. + + |
| Lists | ++ +```rst +* A unordered list +* The second item of the unordered list + with two lines + +#. A numbered list + + 1. A nested numbered list + 2. The second nested numbered list + +#. The second item of + the numbered list +``` + + | ++ +Note that the number of spaces indented depends on the markup. That is, if we use '* '/'#. '/'10. ' for the list, the following contents belong to the list or the nested lists after it should be indented by 2/3/4 spaces. + +Also note that blanks lines are needed around the nested list. + +You could refer [here](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks) for more information on reStructuredText lists. + + |
|
+
+Note, +Warning, +Danger, +Tip, +Important, +See Also +boxes + + |
++ +```rst +.. note:: + + This is a note box. + +.. warning:: + + This is a warning box. + +.. danger:: + + This is a danger box. + +.. tip:: + + This is a tip box. + +.. important:: + + This is an important box. + +.. seealso:: + + This is a see also box. +``` + + | ++ +```eval_rst +.. note:: + + This is a note box. + +.. warning:: + + This is a warning box. + +.. danger:: + + This is a danger box. + +.. tip:: + + This is a tip box. + +.. important:: + + This is an important box. + +.. seealso:: + + This is a see also box. +``` + + |
| Code blocks | ++ +```rst +.. code-block:: [language] + + some code in this language + +.. code-block:: python + + some python code +``` + + | ++ +All the supported language argument for syntax highlighting can be found [here](https://pygments.org/docs/lexers/). + + |
| Tabs | ++ +```rst +.. tabs:: + + .. tab:: Title 1 + + Contents for tab 1 + + .. tab:: Title 2 + + Contents for tab 2 + + .. code-block:: python + + some python code +``` + + | ++ +```eval_rst +.. tabs:: + + .. tab:: Title 1 + + Contents for tab 1 + + .. tab:: Title 2 + + Contents for tab 2 + + .. code-block:: python + + some python code +``` + +You could refer [here](https://sphinx-tabs.readthedocs.io/en/v3.4.0/) for more information on the usage of tabs. + + |
| Cards in grids | +
+
+```rst
+.. grid:: 1 2 2 2
+ :gutter: 2
+
+ .. grid-item-card::
+
+ **Header**
+ ^^^
+ A normal card.
+ +++
+ :bdg-link:`Footer |
+
+
+```eval_rst
+.. grid:: 1 2 2 2
+ :gutter: 2
+
+ .. grid-item-card::
+
+ **Header**
+ ^^^
+ A normal card.
+ +++
+ :bdg-link:`Footer |
| Headers | ++ +```md +# Header Level 1 + +## Header Level 2 + +### Header Level 3 + +#### Header Level 4 +``` + + | ++ +Note that **we do not expect maually-added styles to headers.** + + |
| Lists | ++ +```md +- A unordered list +- The second item of the unordered list + with two lines + +1. A numbered list + * A nested unordered list + * The second nested unordered list +2. The second item of + the numbered list +``` + + | ++ +Note that the number of spaces indented depends on the markup. That is, if we use '- '/'1. '/'10. ' for the list, the following contents belong to the list or the nested lists after it should be indented by 2/3/4 spaces. + + |
| Code blocks | ++ +~~~md +```[language] +some code in this language +``` + +```python +some python code +``` +~~~ + + | ++ +All the supported language argument for syntax highlighting can be found [here](https://pygments.org/docs/lexers/). + + | +