Attention
WARNING: From 9am on 19th August until 5pm on 2nd September there will be no access to the Stanage HPC cluster.
We will send an email to notify you when Stanage is back online and available for job submission.
Custom configuration
Global.rst
Hide external link icons
Usage: add to any page to suppress any external link icons on that page.
|hide-external-link-icons|
Insert line break
Usage: add anywhere you would like to insert a line break
like this:
Usage: add anywhere you would like to insert a line break
|br|
like this:
Underline bold
Some important information
:underline-bold:`Some important information`
Underline-bold has been defined in global.rst and custom.css.
Conf.py
Extensions
- sphinx.ext.todo
todo_include_todos = False
- not included in generated documentation
- sphinx_tabs.tabs
sphinx_tabs_valid_builders = ['linkcheck']
- extension will be enabled when running the linkcheck buildersphinx_tabs_disable_tab_closing = True
- user won’t be able to close tabs in the generated documentation
Currently used directives
Last updated 27.03.2024
.. ::
.. admonition::
.. attention::
.. caution::
.. code-block::
.. contents::
.. cssclass::
.. danger::
.. dropdown::
.. error::
.. figure::
.. glossary::
.. group-tab::
.. highlight::
.. hint::
.. image::
.. important::
.. include::
.. list-table::
.. literalinclude::
.. note::
.. raw::
.. role::
.. seealso::
.. sidebar::
.. tab::
.. table::
.. tabs::
.. tip::
.. toctree::
.. todo::
.. warning::