https://github.com/openforcefield/openff-sphinx-theme

A material-based, responsive theme inspired by mkdocs-material
https://github.com/openforcefield/openff-sphinx-theme

Last synced: 7 days ago
JSON representation

A material-based, responsive theme inspired by mkdocs-material

• Host: GitHub
• URL: https://github.com/openforcefield/openff-sphinx-theme
• Owner: openforcefield
• License: other
• Created: 2021-06-10T01:00:47.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2026-04-16T10:42:32.000Z (about 1 month ago)
• Last Synced: 2026-04-16T11:25:40.126Z (about 1 month ago)
• Language: Sass
• Homepage: https://openforcefield.github.io/openff-sphinx-theme/dev
• Size: 90.6 MB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.md

Awesome Lists containing this project

README

          
OpenFF Sphinx theme

=====================

**License**

|MIT License|

A Material Design theme for Sphinx documentation.

Based on `Material for Sphinx `_.

See the theme's `demonstration site `_ for examples of rendered rst and more detailed instructions.

Getting Started

---------------

Or, add to your ReadTheDocs environment.yml

.. code-block:: yaml

    dependencies:

        - pip

        - 

        - 

        - 

        # --- snip --- #

        - pip:

            - git+https://github.com/openforcefield/openff-sphinx-theme.git@main

Update your ``conf.py`` with the required changes:

.. code-block:: python

    extensions.append("openff_sphinx_theme")

    html_theme = "openff_sphinx_theme"

    html_sidebars = {"**": ["globaltoc.html", "localtoc.html", "searchbox.html"]}

    

There are some basic customization options you probably also wanna set:

.. code-block:: python

    # Theme options are theme-specific and customize the look and feel of a

    # theme further.

    html_theme_options = {

        # Repository integration

        # Set the repo url for the link to appear

        "repo_url": "https://github.com/openforcefield/openff-toolkit",

        # The name of the repo. If must be set if repo_url is set

        "repo_name": "openff-toolkit",

        # Must be one of github, gitlab or bitbucket

        "repo_type": "github",

        # Colour for sidebar captions and other accents. One of

        # openff-blue, openff-toolkit-blue, openff-dataset-yellow,

        # openff-evaluator-orange, aquamarine, lilac, amaranth, grape,

        # violet, pink, pale-green, green, crimson, eggplant, turquoise,

        # or a tuple of three ints in the range [0, 255] corresponding to

        # a position in RGB space.

        "color_accent": "openff-toolkit-blue",

    }

More customization options can be found in the `demonstration site `_.

.. |MIT License| image:: https://img.shields.io/badge/License-MIT-blue.svg

   :target: https://opensource.org/licenses/MIT-Clause