61 mkdocs material fix (#62)

* Fix for mkdocs-material version 5 * Version bump * Travis Updated dependency versions * Fixed deps versions in doc + corrected mkdoc logos + updated icon
bmwcarit · May 26, 2020 · 55362c9 · 55362c9
1 parent 0117311
commit 55362c9
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 20 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -44,21 +44,21 @@ install:
     - sudo apt-get install tree
     - pip3 install -U pylint
     - sudo apt-get install enchant      # needed for pyenchant
-    - pip3 install pyenchant            # needed for pylint spell checking
-    - pip3 install coverage
+    - pip3 install -U pyenchant         # needed for pylint spell checking
+    - pip3 install -U coverage
     # Packages for Emma
-    - pip3 install -U Pygments Markdown matplotlib pandas pypiscout graphviz
+    - pip3 install -U Pygments Markdown matplotlib pandas "pypiscout>=2.0" graphviz
     # Packages for Emma reports + html doc
     - sudo apt-get update
     - sudo apt-get install graphviz
     - pip3 install -U gprof2dot
     # Install pip deployment packages
-    - pip3 install --upgrade setuptools
-    - pip3 install --upgrade wheel
-    - pip3 install --upgrade twine
+    - pip3 install -U setuptools
+    - pip3 install -U wheel
+    - pip3 install -U twine
     # Install mkdocs packages for GitHub pages deployment
-    - pip3 install mkdocs
-    - pip3 install mkdocs-material
+    - pip3 install -U "mkdocs>=1.1.2"
+    - pip3 install -U "mkdocs-material>=5.2.1"
     # List installed pip packages
     - pip3 list
 
@@ -120,10 +120,10 @@ jobs:
                 skip_cleanup: true
                 github_token: $GITHUB_TOKEN
                 local_dir: site
-                on:
-                    tags: true
 #                on:
-#                    branch: master
+#                    tags: true
+                on:
+                    branch: 61-mkdocs-material-fix
               # Deploy on PyPi database
               - provider: pypi
 #                server: https://test.pypi.org/legacy/      # Activate for testing

diff --git a/Emma/__init__.py b/Emma/__init__.py
@@ -24,7 +24,7 @@ class SUBPARSER_STRINGS:
 
 VERSION_MAJOR = "3"
 VERSION_MINOR = "2"
-VERSION_PATCH = "1"
+VERSION_PATCH = "2"
 EMMA_VERSION = ".".join([VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH])
 EMMA_VISUALISER_VERSION = EMMA_VERSION
 EMMA_DELTAS_VERSION = EMMA_VERSION

diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ emma-dev (. at) googlegroups.com
 | Pandas (v0.23.4+)    | [pandas](https://pypi.org/project/pandas/)          | BSD-3-Clause                         | [https://github.com/pandas-dev/pandas/](https://github.com/pandas-dev/pandas/); [http://pandas.pydata.org/getpandas.html](http://pandas.pydata.org/getpandas.html)                           |
 | Pygments (v2.3.1+)   | [Pygments](https://pypi.org/project/Pygments/)      | BSD-2-Clause                         | [https://bitbucket.org/birkenfeld/pygments-main/src/default/](https://bitbucket.org/birkenfeld/pygments-main/src/default/); [http://pygments.org/download/](http://pygments.org/download/)   |
 | Matplotlib (v3.0.0+) | [matplotlib](https://pypi.org/project/matplotlib/)  | Matplotlib License (BSD compatible)  | [https://matplotlib.org/users/installing.html](https://matplotlib.org/users/installing.html); [https://github.com/matplotlib/matplotlib](https://github.com/matplotlib/matplotlib)           |
-| SCout (v1.8+)        | [pypiscout](https://pypi.org/project/pypiscout/)    | MIT                                  | [https://github.com/holzkohlengrill/SCout](https://github.com/holzkohlengrill/SCout)                                                                                                         |
+| SCout (v2.0+)        | [pypiscout](https://pypi.org/project/pypiscout/)    | MIT                                  | [https://github.com/holzkohlengrill/SCout](https://github.com/holzkohlengrill/SCout)                                                                                                         |
 
 
 **Optional dependencies:**
@@ -188,8 +188,8 @@ Utility scripts used to build GitHub pages documentation. As a normal user you c
 
 | Library (version)             | pip package name                                                  | Licence                              | URL                                                                                                                                                |
 |-------------------------------|-------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
-| MkDocs (v1.0.4+)              | [mkdocs](https://pypi.org/project/mkdocs/)                        | BSD-3Clause                          | [https://github.com/mkdocs/mkdocs](https://github.com/mkdocs/mkdocs)                                                                               |
-| Material for MkDocs (v4.4.1+) | [mkdocs-material](https://pypi.org/project/mkdocs-material/)      | MIT                                  | [https://github.com/squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)                                                       |
+| MkDocs (v1.1.2+)              | [mkdocs](https://pypi.org/project/mkdocs/)                        | BSD-3Clause                          | [https://github.com/mkdocs/mkdocs](https://github.com/mkdocs/mkdocs)                                                                               |
+| Material for MkDocs (v5.2.1+) | [mkdocs-material](https://pypi.org/project/mkdocs-material/)      | MIT                                  | [https://github.com/squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)                                                       |
 
 
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,12 +6,16 @@ copyright: The Emma Authors
 docs_dir: doc
 use_directory_urls: False
 theme:
+    features:
+      - tabs
+      - instant
     name: material
     palette:
         primary: "Black"
         accent: "Amber"
-    logo:
-        icon: "🔍"
+    icon:
+        logo: material/magnify
+    #favicon: images/blah.png
     font: false
     language: "en"
     highlightjs: true
@@ -22,7 +26,7 @@ theme:
 
 extra:
   social:
-    - type: 'github'
+    - icon: octicons/mark-github
       link: 'https://github.com/bmwcarit/Emma'
 
 #google_analytics:

diff --git a/setup.py b/setup.py
@@ -68,8 +68,8 @@
     extras_require={"dev":                                      # Install dev version via `pip3 install pypiemma[dev]`
                         ["gprof2dot",
                          "pylint",
-                         "mkdocs",
-                         "mkdocs-material"
+                         "mkdocs>=1.1.2",                       # There was a break in the config files: https://squidfunk.github.io/mkdocs-material/releases/5/
+                         "mkdocs-material>=5.2.1"               # There was a break in the config files: https://squidfunk.github.io/mkdocs-material/releases/5/
                          ],
                     },
     entry_points={                                              # Make Emma available as independent scripts