Package Details: mkdocs-material 5.5.0-1

Git Clone URL: https://aur.archlinux.org/mkdocs-material.git (read-only, click to copy)
Package Base: mkdocs-material
Description: Material design theme for MkDocs
Upstream URL: http://squidfunk.github.io/mkdocs-material/
Licenses: MIT
Submitter: XavierCLL
Maintainer: moscar (dbirks)
Last Packager: dbirks
Votes: 7
Popularity: 0.60
First Submitted: 2017-03-15 00:01
Last Updated: 2020-07-28 02:46

Latest Comments

1 2 Next › Last »

geezus commented on 2021-01-13 15:16

latest release is dated 1/9/21 v6.2.4

https://github.com/squidfunk/mkdocs-material/releases/tag/6.2.4

ccorn commented on 2020-09-14 20:12

@AlphaJack: Both require each other if you look at their requirements files. That's a dependency cycle.

To resolve that, I propose that python-mkdocs-material-extensions-git should fully depend on mkdocs-material>=5.0.0 and add python-mkdocs-material-extensions (without the -git) to its provides. In turn, mkdocs-material could have an optdepends=('python-mkdocs-material-extensions>=1.0: For advanced features').

AlphaJack commented on 2020-09-07 15:46

@ccorn I've just published python-mkdocs-material-extensions-git. The name is long and ugly, but at least there is no need to apply pathes anymore.

@dbirks can you add python-mkdocs-material-extensions-git as a package dependency? I encountered @jiko error and installing this package fixed it.

ccorn commented on 2020-07-25 08:51

Not sure why AUR does not like my Markdown. Marker renders it.

ccorn commented on 2020-07-25 08:32

I have made a `PKGBUILD` for `mkdocs-material-extensions`, but I am not interested in maintaining it. Two notes:

* I suppose the proper package name would be `python-mkdocs-material-extensions` (or `python-materialx` as `materialx` is the import name of the module).
* I had to backport [this patch from commit f6fb12e to `tests/extensions/test_emoji.py`](https://github.com/facelessuser/mkdocs-material-extensions/commit/f6fb12eab5620b2de0b9bd5a74864d0cc11d56ab#diff-5381538ff5623d3492b9c600938024e1) to get the octicons test working:

Backport test fix from commit f6fb12e
--- a/tests/extensions/test_emoji.py
+++ b/tests/extensions/test_emoji.py
@@ -23,7 +23,7 @@ def test_material_svg_injection(self):

We can also use Fontawesome Icons :fontawesome-solid-ambulance:.

- That's not all, we can also use Octicons :octicons-octoface:.
+ That's not all, we can also use Octicons :octicons-octoface-16:.
''',
r'''
<p>We can use Material Icons <span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 16v-2l-8-5V3.5A1.5 1.5 0 0011.5 2 1.5 1.5 0 0010 3.5V9l-8 5v2l8-2.5V19l-2 1.5V22l3.5-1 3.5 1v-1.5L13 19v-5.5l8 2.5z"/></svg></span>.</p>

The `PKGBUILD` header is

_pyname=mkdocs-material-extensions
pkgname=("python-${_pyname}")
pkgver=1.0
pkgrel=1
pkgdesc="python-markdown extension to access mkdocs-material resources"
arch=('any')
url="https://github.com/facelessuser/mkdocs-material-extensions"
license=('MIT')
depends=('mkdocs-material>=5.0.0')
makedepends=('python-setuptools')
source=("https://files.pythonhosted.org/packages/source/${_pyname:0:1}/${_pyname}/${_pyname}-${pkgver}.tar.gz"
"https://github.com/facelessuser/mkdocs-material-extensions/raw/master/LICENSE.md"
"patch-test-emoji.py.diff")
sha256sums=(17d7491e189af75700310b7ec33c6c48a22060b8b445001deca040cb60471cde
f33afc0874d05cf4bd3020a7b0c5940c6b9eb590f4ed16b6a1fd3d0132c4af34
82d30c98745a63e72b371d2ac76f6c7a5b9a425fa3810415e4d961be2c3022a0)

prepare() {
cd "${srcdir}/${_pyname}-${pkgver}"

patch -p1 -i "${srcdir}/patch-test-emoji.py.diff"
}

And the rest is as usual.

jiko commented on 2020-07-23 12:19

I had to pip install mkdocs-material-extensions to get this working, otherwise I was getting:

$ mkdocs serve                                           
INFO    -  Building documentation... 
Traceback (most recent call last):
  File "/usr/bin/mkdocs", line 33, in <module>
    sys.exit(load_entry_point('mkdocs==1.1.2', 'console_scripts', 'mkdocs')())
  File "/usr/lib/python3.8/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.8/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.8/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.8/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.8/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/usr/lib/python3.8/site-packages/mkdocs/__main__.py", line 133, in serve_command
    serve.serve(
  File "/usr/lib/python3.8/site-packages/mkdocs/commands/serve.py", line 141, in serve
    config = builder()
  File "/usr/lib/python3.8/site-packages/mkdocs/commands/serve.py", line 122, in builder
    config = load_config(
  File "/usr/lib/python3.8/site-packages/mkdocs/config/base.py", line 197, in load_config
    errors, warnings = cfg.validate()
  File "/usr/lib/python3.8/site-packages/mkdocs/config/base.py", line 115, in validate
    post_failed, post_warnings = self._post_validate()
  File "/usr/lib/python3.8/site-packages/mkdocs/config/base.py", line 95, in _post_validate
    config_option.post_validation(self, key_name=key)
  File "/usr/lib/python3.8/site-packages/mkdocs/config/config_options.py", line 469, in post_validation
    config[key_name] = theme.Theme(**theme_config)
  File "/usr/lib/python3.8/site-packages/mkdocs/theme.py", line 45, in __init__
    self._load_theme_config(name)
  File "/usr/lib/python3.8/site-packages/mkdocs/theme.py", line 75, in _load_theme_config
    theme_dir = utils.get_theme_dir(name)
  File "/usr/lib/python3.8/site-packages/mkdocs/utils/__init__.py", line 297, in get_theme_dir
    return os.path.dirname(os.path.abspath(theme.load().__file__))
  File "/usr/lib/python3.8/site-packages/pkg_resources/__init__.py", line 2460, in load
    self.require(*args, **kwargs)
  File "/usr/lib/python3.8/site-packages/pkg_resources/__init__.py", line 2483, in require
    items = working_set.resolve(reqs, env, installer, extras=self.extras)
  File "/usr/lib/python3.8/site-packages/pkg_resources/__init__.py", line 785, in resolve
    raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'mkdocs-material-extensions>=1.0' distribution was not found and is required by the application

dicta commented on 2020-02-24 21:55

mkdocs-material 4.6.1 and later (currently packaged version is 4.6.3) require python-markdown >= 3.2, while the latest packaged version in Arch is still 3.1.1. The package for python-markdown was flagged out-of-date on 07 Feb 2020 but has not yet been updated.

https://github.com/squidfunk/mkdocs-material/commit/92bfb148ed670281a733122aa63ef134256a47c7 is the commit that introduces the updated dependencies.

Also, it appears we don't have an explicit dependency on python-markdown at all in this package -- should that also be updated?

dbirks commented on 2019-12-17 14:51

Dargmuesli: Thank you, it looks like they re-released the binary to the same version number. Updated now.

Dargmuesli commented on 2019-12-17 11:54

The current checksum seems to be incorrect.

noraj commented on 2019-07-24 16:23

python-mkdocs-minify-plugin is required else:

$  mkdocs serve                                                                                                                                                                                                                                                                  
INFO    -  Building documentation...                                                                                                                                                                                                                                            
Traceback (most recent call last):                                                                                                                                                                                                                                              
  File "/usr/bin/mkdocs", line 11, in <module>                                                                                                                                                                                                                                  
    load_entry_point('mkdocs==1.0.4', 'console_scripts', 'mkdocs')()                                                                                                                                                                                                            
  File "/usr/lib/python3.7/site-packages/click/core.py", line 764, in __call__                                                                                                                                                                                                  
    return self.main(*args, **kwargs)                                                                                                                                                                                                                                           
  File "/usr/lib/python3.7/site-packages/click/core.py", line 717, in main                                                                                                                                                                                                      
    rv = self.invoke(ctx)                                                                                                                                                                                                                                                       
  File "/usr/lib/python3.7/site-packages/click/core.py", line 1137, in invoke                                                                                                                                                                                                   
    return _process_result(sub_ctx.command.invoke(sub_ctx))                                                                                                                                                                                                                     
  File "/usr/lib/python3.7/site-packages/click/core.py", line 956, in invoke                                                                                                                                                                                                    
    return ctx.invoke(self.callback, **ctx.params)                                                                                                                                                                                                                              
  File "/usr/lib/python3.7/site-packages/click/core.py", line 555, in invoke                                                                                                                                                                                                    
    return callback(*args, **kwargs)                                                                                                                                                                                                                                            
  File "/usr/lib/python3.7/site-packages/mkdocs/__main__.py", line 134, in serve_command                                                                                                                                                                                        
    livereload=livereload                                                                                                                                                                                                                                                       
  File "/usr/lib/python3.7/site-packages/mkdocs/commands/serve.py", line 119, in serve                                                                                                                                                                                          
    config = builder()                                                                                                                                                                                                                                                          
  File "/usr/lib/python3.7/site-packages/mkdocs/commands/serve.py", line 107, in builder                                                                                                                                                                                        
    site_dir=site_dir                                                                                                                                                                                                                                                           
  File "/usr/lib/python3.7/site-packages/mkdocs/config/base.py", line 197, in load_config                                                                                                                                                                                       
    errors, warnings = cfg.validate()                                                                                                                                                                                                                                           
  File "/usr/lib/python3.7/site-packages/mkdocs/config/base.py", line 115, in validate                                                                                                                                                                                          
    post_failed, post_warnings = self._post_validate()                                                                                                                                                                                                                          
  File "/usr/lib/python3.7/site-packages/mkdocs/config/base.py", line 95, in _post_validate                                                                                                                                                                                     
    config_option.post_validation(self, key_name=key)                                                                                                                                                                                                                           
  File "/usr/lib/python3.7/site-packages/mkdocs/config/config_options.py", line 432, in post_validation                                                                                                                                                                         
    config[key_name] = theme.Theme(**theme_config)                                                                                                                                                                                                                              
  File "/usr/lib/python3.7/site-packages/mkdocs/theme.py", line 48, in __init__                                                                                                                                                                                                 
    self._load_theme_config(name)                                                                                                                                                                                                                                               
  File "/usr/lib/python3.7/site-packages/mkdocs/theme.py", line 78, in _load_theme_config                                                                                                                                                                                       
    theme_dir = utils.get_theme_dir(name)                                                                                                                                                                                                                                       
  File "/usr/lib/python3.7/site-packages/mkdocs/utils/__init__.py", line 278, in get_theme_dir                                                                                                                                                                                  
    return os.path.dirname(os.path.abspath(theme.load().__file__))                                                                                                                                                                                                              
  File "/usr/lib/python3.7/site-packages/pkg_resources/__init__.py", line 2433, in load                                                                                                                                                                                         
    self.require(*args, **kwargs)                                                                                                                                                                                                                                               
  File "/usr/lib/python3.7/site-packages/pkg_resources/__init__.py", line 2456, in require                                                                                                                                                                                      
    items = working_set.resolve(reqs, env, installer, extras=self.extras)                                                                                                                                                                                                       
  File "/usr/lib/python3.7/site-packages/pkg_resources/__init__.py", line 786, in resolve                                                                                                                                                                                       
    raise DistributionNotFound(req, requirers)                                                                                                                                                                                                                                  
pkg_resources.DistributionNotFound: The 'mkdocs-minify-plugin>=0.2' distribution was not found and is required by the application

I installed it and it worked just after. The default theme works without it. So it is a dependency of the material theme.