Usage

Install Conestack Sphinx Theme with pip:

pip install sphinx-conestack-theme

Create your sphinx project:

sphinx-quickstart

Sphinx theme confguration is done in the conf.py file of your docs source folder.

To activate the theme, html_theme must be set:

html_theme = 'conestack'

See here for more information about boilerplating sphinx documentation projects and here for a detailed documentation about customizing Sphinx themes.

Theming options

Theme colors

The Header background and text colors can be customized by defining cs_color and cs_bg_color HTML theme options in conf.py:

html_theme_options = {
    'cs_color': '#FFFFFF',
    'cs_bg_color': 'var(--bs-indigo)'
}

Tip

Hex code (Format #000000) and Bootstrap variables are both supported.

Logo options

The Logo is customized by setting the following HTML theme options.

html_theme_options = {
    'logo_url': '_static/your_logo.svg',
    'logo_title': 'Your-Title',
    'logo_width': '40px',
    'logo_height': '40px'
}

Layout options

Customize your layout by overwriting the following variables:

html_theme_options = {
    'sidebar_left_width': '',
    'sidebar_right_width': '',
    'layout_width': ''
}

The given parameter is set in css with the min-width property for sidebars, and max-width for the layout.

All changes are implemented desktop-only.

Tip

Most css syntax is supported, including, but not limited to:

• px

• rem

• calc()

• %

• min-content and max-content

Example:

html_theme_options = {
    'sidebar_left_width': 'calc(100px - 2rem)',
    'sidebar_right_width': '150px',
    'layout_width': '100%'
}

Important

Customization has its limits. If you choose to include custom styles, make sure your layout composition works on different browser sizes.

Sidebar display

By default, the local toc (table of contents) will be displayed on desktop viewports.

If you want to disable the local toc (sidebar_right):

html_theme_options = {
    'sidebar_right': False
}

External links

You can link to your twitter, github, gitlab, pypi or npm account in the header by inserting the URL in the corresponding variable.

html_theme_options = {
    'twitter_url': 'https://twitter.com/your-account',
    'github_url': 'https://github.com/your-repo',
    'gitlab_url': 'https://gitlab.com/your-repo',
    'pypi_url': 'https://pypi.org/project/your-package',
    'npm_url': 'https://npmjs.com/your-package'
}

Note

If a variable is empty, the corresponding icon will not be displayed.

On this page