Sphinx MCL Theme¶

Responsive and configurable theme for your documentation with blocky look and feel.

Getting Started

Install theme as a python package.

getting-started/installation.html

Configuration

Discover how to configure theme to suit your needs.

configuration/index.html

Kitchen Sink

Discover how things look like in this theme.

kitchen-sink/index.html

Built-in Directives

Learn to use MCL Theme extras for game UI, infoboxes and more.

extras/index.html

What is this theme all about?¶

MCL Theme is a Sphinx theme that draws inspiration from Minecraft Wiki, Pixel Perfection and Mineclonia visuals.

It is built as an extension and can be used with Sphinx 9+ running on Python 3.13 and newer, although we plan to expand the range of supported versions in the future. It is also supposedly agnostic to parsing backend (this documentation is built with MyST and this theme is confirmed to be working with rST and Jupyter Notebooks).

Features¶

The theme supports most of what Sphinx has to offer and comes with responsive layout and light/dark mode support. Along with styles for vanilla features, we do ship some for certain extensions:

Extension Support

Project background¶

This theme was primarily built for Mineclonia Wiki and as such it is rather opinionated and includes features most suitable for projects in the ecosystem or very close to it.

Can I use it for my app’s docs?¶

Yes, of course! Just keep in mind that the theme is still early in development and you might encounter issues. Some things about implementation might also surprise and/or upset you, but ultimately it is a theme made mostly for one project with very specific needs. Still, that should not deter you from submitting a feature request or a bug report, should you find something not up to your liking.

Can extensions be used without the theme?¶

They are pacakged with the theme for now, but nothing should stop you from using custom directives and scriptlets. Do keep in mind that you’ll need to copy CSS for the components used if you’re using other theme.

Credits¶

This documentation is released under the terms of GNU Free Documentation License with the following exceptions:

Source code under docs/kitchen-sink/ and generated web pages under kitchen-sink/ is an almost identical adaptation of Pradyun Gedam’s work on the Sphinx Themes project.

Those files are released under the terms of CC-BY-SA-4.0 license.
Source code under dpcs/extensions/nbsphinx.ipynb and dpcs/extensions/jupyer-sphinx.md is an adaptation of Hsiaoming Yang’s work on the documentation of Shibuya Theme’s documentation.

Those files, together with generated web pages (extensions/nbsphinx.html and extensions/jupyter-sphinx.html), are released under the terms of BSD 3-Clause License.

Full credits for the theme are available in the LEGAL.md file located in the theme’s repository.