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

Broken default favicon link #639

Closed
brianhlin opened this Issue Dec 16, 2017 · 5 comments

Comments

Projects
None yet
2 participants
@brianhlin
Contributor

brianhlin commented Dec 16, 2017

Description

Without specifying favicon in the theme configuration, sites get built with links to an incorrect favicon path.

Expected behavior

The default favicon path to be set to assets/images/favicon.ico

Actual behavior

The default favicon path is set to assets/images/favicon.png

Here's an example in our Travis-CI builds where the broken link is causing linkchecker failures: https://travis-ci.org/opensciencegrid/docs/builds/317387820

Steps to reproduce the bug

  1. Create a mkdocs.yml without specifying favicon
  2. mkdocs build
  3. grep -R favicon site/
  4. find site/ -name favicon*

Package versions

  • Python: python --version - 2.7.14
  • MkDocs: mkdocs --version - 0.17.1
  • Material: pip show mkdocs-material | grep -E ^Version - 2.2.3

Project configuration

This is the most basic config to reproduce the issue:

site_name: Test
theme:
  name: material

pages:
- Home: 'index.md'

System information

  • OS: Ubuntu 14.04.5 LTS
  • Browser: N/A

brianhlin added a commit to opensciencegrid/docs that referenced this issue Dec 16, 2017

@squidfunk

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Dec 18, 2017

Owner

Can you check if the *.png file exists? The *.ico is just a fallback and Material uses the stated *.png file as a favicon. When I build it locally, everything is there.

Owner

squidfunk commented Dec 18, 2017

Can you check if the *.png file exists? The *.ico is just a fallback and Material uses the stated *.png file as a favicon. When I build it locally, everything is there.

@brianhlin

This comment has been minimized.

Show comment
Hide comment
@brianhlin

brianhlin Dec 18, 2017

Contributor

No such luck:

$ pwd
/home/brian/work/docs
$ PYTHONPATH=src mkdocs build 
INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/brian/work/docs/site 
$ find site/ -iname favicon.png
$ 
Contributor

brianhlin commented Dec 18, 2017

No such luck:

$ pwd
/home/brian/work/docs
$ PYTHONPATH=src mkdocs build 
INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/brian/work/docs/site 
$ find site/ -iname favicon.png
$ 
@squidfunk

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Dec 18, 2017

Owner

There's indeed a bug in the MANIFEST file, will provide a fix!

Owner

squidfunk commented Dec 18, 2017

There's indeed a bug in the MANIFEST file, will provide a fix!

@squidfunk squidfunk self-assigned this Dec 18, 2017

@squidfunk squidfunk added the bug label Dec 18, 2017

@squidfunk

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Dec 18, 2017

Owner

Fixed in #642

Owner

squidfunk commented Dec 18, 2017

Fixed in #642

@squidfunk

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Dec 18, 2017

Owner

Released as part of 2.2.5.

Owner

squidfunk commented Dec 18, 2017

Released as part of 2.2.5.

@squidfunk squidfunk closed this Dec 18, 2017

brianhlin added a commit to opensciencegrid/technology that referenced this issue Dec 22, 2017

brianhlin added a commit to opensciencegrid/technology that referenced this issue Dec 22, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment