Skip to content

Commit be28757

Browse files
committed
adjusted docs
1 parent 48675bc commit be28757

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

doc/source/_static/custom.css

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/*
2+
Custom CSS for stderr stream output.
3+
*/
4+
5+
.stderr {
6+
background-color: #FCC;
7+
}

doc/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,4 @@
4141
"repo": "jupyter/jupyter-sphinx",
4242
},
4343
}
44+
html_static_path = ["_static/custom.css"] # css overrides for Alabaster theme

doc/source/index.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,10 +251,13 @@ produces:
251251

252252
print("hello, world!", file=sys.stderr)
253253

254-
.. warning::
254+
.. note::
255+
To `adjust the CSS <https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html>`_
256+
of the ``stderr`` stream, use the ``stderr`` class. If you are using the default
257+
Sphinx theme, for example, add the following
258+
`custom CSS <https://alabaster.readthedocs.io/en/latest/customization.html#custom-stylesheet>`_:
259+
``.stderr {background-color: #FCC}``.
255260

256-
Note that output written to ``stderr`` is not displayed any differently than output written
257-
to ``stdout``.
258261

259262
Controlling the execution environment
260263
-------------------------------------

0 commit comments

Comments
 (0)