Scientific Python Hugo Theme documentation

Scientific Python Hugo theme released!

Mon, 18 Oct 2021 00:00:00 +0000

Based on the theme developed for numpy.org.

Mon, 01 Jan 0001 00:00:00 +0000

This is some example markdown with bold!

Admonitions

Mon, 01 Jan 0001 00:00:00 +0000

We provide several different types of admonitions.

`attention`#

Attention

Climate change is real.

`caution`#

Caution

Cliff ahead: Don't drive off it.

Blocks

Mon, 01 Jan 0001 00:00:00 +0000

Block Quotes#

Block quotes consist of indented body elements:

My theory by A. Elk. Brackets Miss, brackets. This theory goes as follows and begins now. All brontosauruses are thin at one end, much much thicker in the middle and then thin again at the far end. That is my theory, it is mine, and belongs to me and I own it, and what it is too.

—Anne Elk (Miss)

Features

Mon, 01 Jan 0001 00:00:00 +0000

Hugo Layouts#

_default/single.html : Single page layout
_default/section.html : Section layout (a section typically has _index.md and contains other pages)

Blog post layouts:

layouts/partials/posts/post.html: Blog post layout
layouts/partials/posts/list.html: Blog post listing layout
layouts/partials/posts/tag.html: Tag page layout
layers/partials/posts/comments.html: Empty by default; can be overridden to place a comments section

Add custom HTML header content#

layouts/partials/head.html

Shortcut list#

The depths of the shortcut list on the left of each post can be controlled by setting the shortcutDepth parameter in the post preamble. It defaults to 2.

Get Help

Mon, 01 Jan 0001 00:00:00 +0000

Please see our issue tracker.

Get Started

Mon, 01 Jan 0001 00:00:00 +0000

The Scientific Python Hugo Theme is a theme for the Hugo static site generator, inspired by the PyData Sphinx Theme.

To use this theme on your site, follow these instructions:

Dependencies#

Install Hugo. Either the standard or extended editions of Hugo will work.

Verify that hugo is on your PATH:

$ hugo version
hugo v0.120.3-a4892a07b41b7b3f1f143140ee4ec0a9a5cf3970 linux/amd64 BuildDate=2023-11-01T17:57:00Z VendorInfo=gohugoio

Install Dart Sass.

You can also install Hugo as a snap, which includes Dart Sass.

Shortcodes

Mon, 01 Jan 0001 00:00:00 +0000

Markdown is a convenient and simple format to write in. However, it doesn’t always do everything we want (or do it in a nice way). Rather than adding raw HTML to our source files, Hugo allows us to use shortcodes. Shortcodes are small snippets that look like this

{{< _shortcodename parameters_ >}}

that Hugo renders using a predefined template.

Tables

Mon, 01 Jan 0001 00:00:00 +0000

Markdown Tables#

The theme supports GFM table markdown.

Syntax	Description
Header	Title
Paragraph	Text

Markdown tables can be aligned:

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

Table shortcode#

This is a feature preview and is not ready for adoption:

Project	Available Packages	Download location
NumPy	Official source code (all platforms) and binaries for Windows, Linux, and Mac OS X	PyPi page for NumPy
SciPy	Official source code (all platforms) and binaries for Windows, Linux and Mac OS X	SciPy release page (sources) PyPI page for SciPy (all)

Theme variables and CSS

Mon, 01 Jan 0001 00:00:00 +0000

This section covers a few ways that you can control the look and feel of your theme via your own CSS and theme variables.

Custom CSS stylesheets#

Custom styles should be added to /assets/css/my_css.css (where my_css can be any name, other than those already in the theme).

CSS theme variables#

Fonts#

To override the fonts used, add a custom CSS file and set the following variables:

Typography

Mon, 01 Jan 0001 00:00:00 +0000

This is quite important, for a website where the majority of the content is going to be prose.

Notice the font family being used for the prose, as well as the font family being used for the heading. Think about the spacing between the lines, as well as the spacing between various paragraphs. Also keep the font weight in mind, and consider if/how you want antialiasing and font-smoothing to work.

Web Design Components

Mon, 01 Jan 0001 00:00:00 +0000

The PyData Sphinx Theme uses sphinx-design to add several UI components and provide extra flexibility for content creation. These include badges, buttons, cards, and tabs, among other components. This theme provides custom CSS to ensure that sphinx-design elements look and feel consistent with this theme.

Seealso

For more information about how to use these extensions, see the sphinx-design documentation.

Below you can find some examples of the components created with the sphinx-design extension.

Scientific Python Hugo Theme documentation

Scientific Python Hugo theme released!

Admonitions

attention#

caution#

Blocks

Block Quotes#

Features

Hugo Layouts#

Add custom HTML header content#

Shortcut list#

Get Help

Get Started

Dependencies#

Shortcodes

Tables

Markdown Tables#

Table shortcode#

Theme variables and CSS

Custom CSS stylesheets#

CSS theme variables#

Fonts#

Typography

Web Design Components

`attention`#

`caution`#