========================== updates from Mu start ========================
- Install the theme by
pip install https://github.com/mli/mx-theme/tarball/master- Modify the
conf.pyfor your sphinx project by
create a submodule of this repo on the same folder with conf.py for your sphinx project. then modify the following three lines in conf.py:
html_theme_path = ['mxtheme']
html_theme = 'mxtheme'and add the following two lines into your def setup(app) function:
def setup(app):
...
import mxtheme
app.add_directive('card', mxtheme.CardDirective)first install the following package (assume on ubuntu):
wget -qO- https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
npm install npm-run-all node-sass parcel
then build through
npm run build
========================== updates from Mu end ========================
- python
- Sphinx
Install the latest version of sphinx_materialdesign_theme with pip.
pip install sphinx_materialdesign_themeAdd the following line to conf.py.
html_theme = 'sphinx_materialdesign_theme'The following is a description of the options that can be specified in html_theme_options in your project's conf.py.
html_theme_options = {
# Specify a list of menu in Header.
# Tuples forms:
# ('Name', 'external url or path of pages in the document', boolean, 'icon name')
#
# Third argument:
# True indicates an external link.
# False indicates path of pages in the document.
#
# Fourth argument:
# Specify the icon name.
# For details see link.
# https://material.io/icons/
'header_links' : [
('Home', 'index', False, 'home'),
("ExternalLink", "http://example.com", True, 'launch'),
("NoIconLink", "http://example.com", True, ''),
("GitHub", "https://github.com/myyasuda/sphinx_materialdesign_theme", True, 'link')
],
# Customize css colors.
# For details see link.
# https://getmdl.io/customize/index.html
#
# Values: amber, blue, brown, cyan deep_orange, deep_purple, green, grey, indigo, light_blue,
# light_green, lime, orange, pink, purple, red, teal, yellow(Default: indigo)
'primary_color': 'indigo',
# Values: Same as primary_color. (Default: pink)
'accent_color': 'pink',
# Customize layout.
# For details see link.
# https://getmdl.io/components/index.html#layout-section
'fixed_drawer': True,
'fixed_header': True,
'header_waterfall': True,
'header_scroll': False,
# Render title in header.
# Values: True, False (Default: False)
'show_header_title': False,
# Render title in drawer.
# Values: True, False (Default: True)
'show_drawer_title': True,
# Render footer.
# Values: True, False (Default: True)
'show_footer': True
}python setup.py sdist
pip install dist/sphinx_materialdesign_theme-${version}.tar.gz
python setup.py register sdist upload
sphinx-build -b html ./example ./_build -c ./example
| thirdparty | version | license | URL |
|---|---|---|---|
| Material Design Lite | 1.3.0 | Apache 2.0 | https://github.com/google/material-design-lite/blob/mdl-1.x/LICENSE |
| Material design icons | 3.0.1 | Apache 2.0 | https://github.com/google/material-design-icons/blob/master/LICENSE |