Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extends docs with hint when migrating #239

Merged
merged 5 commits into from
Apr 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,23 @@ significantly diverged from the upstream `mkdocs-material
Getting Started
---------------

Installation
~~~~~~~~~~~~

From the PyPI
^^^^^^^^^^^^^

.. code-block:: bash

pip install sphinx-immaterial

From git source
^^^^^^^^^^^^^^^

.. code-block:: bash

pip install git+https://github.com/jbms/sphinx-immaterial.git

.. admonition:: Prerequisites

Building the theme from source requires node.js v14 or newer installed.
Expand All @@ -41,11 +58,9 @@ Getting Started
Installing from a distributed wheel (such as from pypi.org) does not require
node.js installed.

Install from git source

.. code-block:: bash

pip install git+https://github.com/jbms/sphinx-immaterial.git
Sphinx configuration
~~~~~~~~~~~~~~~~~~~~

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

Expand All @@ -66,6 +81,12 @@ or ``theme.conf`` for more details.
:start-after: # -- HTML theme specific settings
:end-before: # end html_theme_options

.. important::
:title: Migrating from another theme
:collapsible:

Be advised to clean prior builds before the first build with a new theme.


.. toctree::
:hidden:
Expand Down