Skip to content

Latest commit

 

History

History
132 lines (78 loc) · 2.55 KB

File metadata and controls

132 lines (78 loc) · 2.55 KB

Sphinx extension styles

This page shows of some special-case styling for various Sphinx extensions.

sphinxcontrib-bibtex - References and bibliographies

sphinxcontrib-bibtex provides support for citations and bibliographies.

Because this theme deals with scholarly and scientific communication, sphinxcontrib-bibtex should work particularly well.

Here's are a few citations:

  • Default citation {cite}project_jupyter-proc-scipy-2018, {cite}holdgraf_rapid_2016,project_jupyter-proc-scipy-2018. (should be same as parenthetical)
  • Parenthetical citation {cite:p}project_jupyter-proc-scipy-2018, {cite:p}holdgraf_rapid_2016,project_jupyter-proc-scipy-2018.
  • Textual citation {cite:t}project_jupyter-proc-scipy-2018, {cite:t}holdgraf_rapid_2016,project_jupyter-proc-scipy-2018.

And here's a bibliography:

ABlog - Blog post list

ABlog is a Sphinx extension for blogging with Sphinx.

Here's a sample post list:

:date: "%Y-%m-%d"
:format: "{date} - {title}"
:excerpts:

sphinx-togglebutton - Toggle content with buttons

A block toggle:


:::{note} This note is toggled!
:::

A block toggle in the margin:

::::{container} margin


:::{note} This note is toggled!
:::

::::

An admonition toggle:

:::{note} :class: dropdown

This note will be toggled!

:::

An admonition toggle in the margin

::::{note} :class: margin

:::{toggle}

This toggle is in the margin!

:::

::::

sphinx-tabs - Tabbed content

% For some reason sphinx-tabs doesn't work properly with myst markdown % so using rST here.

.. tabs::

   .. tab:: Apples

      Apples are green, or sometimes red.

   .. tab:: Pears

      Pears are green.

   .. tab:: Oranges

      Oranges are orange.

sphinxcontrib.youtube for videos

sphinxcontrib.youtube makes it possible to easily embed videos in your documentation.

sphinx-design for UI components

sphinx-design provides various UI components like badges, cards, and dropdowns.

Badge:

{bdg-primary}Test badge.

Card:

::::{card} Card Title :class-card: sd-border-0 Card header. ^^^ Card content goes here. This demonstrates how cards look in both light and dark modes. +++ Card footer. ::::

Dropdown:

:::{dropdown} Click to expand This is the dropdown content. It should be readable in both light and dark modes. :::