vatlab/sos-docs

Tips and warnings in sos docs

Closed this issue · 1 comments

We use jupyter notebook to prepare our documentation, which does not provide pre-specified template for tips and warmings. We should create some css styles for such items, include them in our documentation css, and use them in our doc. Unfortunately we have to use pure HTML to insert such items if we are to use css styles.

A random search yields some css.

  1. Right click, view source and locate css files used by our homepage and documentation. For example,
  <link href="css/testtab.css" rel="stylesheet">

refers to this file

  1. Learn some css basics (there are tutorials everywhere)
  2. Copy/paste some css for tip etc to this file.
  3. Learn how to use pure HTML in jupyter notebook cell. Insert for example a warning.
  4. Use something like 'sos convert page.ipynb page.html --template toc_tut` and check the html file if the warning is displayed correctly.
  5. Push the css.