useblocks / groundwork-sphinx-theme Goto Github PK

I've tried a few other sphinx themes with success but I found that after these steps, the make html command produces a theme not found type error:

1. pip install groundwork-sphinx-theme
2. nano conf.py
3. Updating html_theme = 'groundwork'

This error is produced:

make html
Running Sphinx v2.2.0
loading pickled environment... done

Theme error:
no theme named 'groundwork' found (missing theme.conf?)
make: *** [html] Error 2

Any suggestions?

Environment

OS: Windows 10 build 1903
Python: 3.8.0
Sphinx version: v2.2.1

Steps to reproduce:

1. pip install groundwork-sphinx-theme
2. edit conf.py

html_theme = 'groundwork'

html_theme_options = {
    "sidebar_width": '240px',
    "stickysidebar": True,
    "stickysidebarscrollable": True,
}

3. make.bat html

Error log:

Running Sphinx v2.2.1
loading translations [zh_CN]... done
loading pickled environment... done

Exception occurred:
  File "<frozen importlib._bootstrap>", line 973, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'flask_theme_support'
The full traceback has been saved in C:\Users\uniq\AppData\Local\Temp\sphinx-err-7v7ee0fy.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

My workaround:

1. find theme.conf in /Lib/site-packages/groundwork_sphinx_theme/theme.conf
2. edit theme.conf

pygments_style = groundwork_sphinx_theme.flask_theme_support.FlaskyStyle

3. make.bat html works fine now.

It is not possible to add a custom logo on the theme.

This might just be me, but I tend to view a lot of documentation on my phone. I think mobile support for this theme would be awesome.