mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-08-26 10:28:24 +00:00
Kevin Putnam
f6b6364490
* Adds support for sphinx_copybutton. Closes #1134 Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Additional config. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Remove cruft.;) Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * **DO NOT MERGE** Please verify changes with tutorials/proxy.rst. Once verified remove changes to proxy.rst. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Provides example usage of new codeblock copy behavior: 1. ShellSession (line 228 in kernel-modules-dkms.rst) - will copy everything except prompt. 2. Console (line 74 in kernel-modules-dkms.rst) - will copy only the input line without the prompt. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> Co-authored-by: Michael Vincerra <michael.vincerra@intel.com>
OTC-TCS Sphinx Theme
####################
Built on top of the popular Read the Docs Sphinx theme, this theme
has a few small formatting/color improvements and implements collapsible
sections. It is in active development in order to support OTC and other
Intel organizations to publish high quality, consistent documentation
for open source projects.
To see an example of documentation produced using this theme visit the
`OTC-TCS Documentation`_ site.
How to use it
*************
#. Download or clone the repository
#. Create a ``_themes`` directory in main directory of your sphinx
documentation
#. Install sphinx_rtd_theme using pip: ``pip3 install sphinx_rtd_theme``
#. copy ``otc_tcs_sphinx_theme`` directory into the new ``_themes`` directory
#. Add the following to your ``conf.py``:
.. code-block:: python
html_theme = 'otc_tcs_sphinx_theme'
html_theme_path = ['_themes']
.. _OTC-TCS Documentation: https://github.intel.com/pages/otc-tcs/