How to setup a sandbox to play with mkdocs-material source?

[yves-chevallier]

I'd like to make some changes to mkdocs, but the usual way doesn't seem to work.

mkdir sandbox && cd sandbox
poetry init

Then adds:

[tool.poetry]
package-mode = false

Then git clone my fork of mkdocs-material-insiders.git /home/doe/mkdocs-material

poetry add mkdocs
poetry install
poetry shell
pip install -e /home/doe/mkdocs-material

Normally I installed mkdocs-material as an editable local package, but when I look at pip freeze:

$ pip freeze | grep insiders
-e git+ssh://git@github.com/john-doe/mkdocs-material-insiders.git@5535d6243b32a205cd613bd5cb33c7da298698b7#egg=mkdocs_material

Where the commit is indeed my patch. However when I modify some templates they don't seem to be used.

$ mkdocs serve --dirtyreload -v
DEBUG   -  Loading configuration file: /home/doe/sandbox/mkdocs.yml
DEBUG   -  Loaded theme configuration for 'material' from
           '/home/doe/mkdocs-material-insiders/material/templates/mkdocs_theme.yml': {'language': 'en', 'direction':
           None, 'features': [], 'font': {'text': 'Roboto', 'code': 'Roboto Mono'}, 'icon': None, 'favicon':
           'assets/images/favicon.png', 'static_templates': ['404.html']}
DEBUG   -  Config value 'config_file_path' = '/home/doe/sandbox/mkdocs.yml'
...
DEBUG   -  No translations found here:
           '/home/doe/.cache/pypoetry/virtualenvs/sandbox-93EedgTJ-py3.12/lib/python3.12/site-packages/mkdocs/templates/locales'
DEBUG   -  No translations found here: '/home/doe/mkdocs-material-insiders/material/templates/locales'
DEBUG   -  Looking for translations for locale 'en'

INFO    -  Documentation built in 0.18 seconds
DEBUG   -  [17:05:39] Watching '/home/doe/sandbox/docs'
DEBUG   -  [17:05:39] Watching '/home/doe/sandbox/mkdocs.yml'
DEBUG   -  Running `serve` event from plugin 'material/search'
INFO    -  [17:05:39] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO    -  [17:05:39] Serving on http://127.0.0.1:8000/

So it seems I am using the local version, but when I attempt to modify any of the /home/doe/mkdocs-material-insiders/src/templates/partials/ they don't seem to be updated.

I am missing something? Is there some additional commands to run?

[squidfunk]

Have you read our theme development guide? You're likely missing the build step.

[yves-chevallier]

Not yet. I was looking for this chapter in "Community" and "Insiders" tabs. But this is exactly what I was looking for. Thanks.