All Projects → myyasuda → sphinx_materialdesign_theme

myyasuda / sphinx_materialdesign_theme

Licence: MIT license
Material Design Html Theme for Sphinx.

Programming Languages

CSS
56736 projects
javascript
184084 projects - #8 most used programming language
HTML
75241 projects
python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to sphinx materialdesign theme

sphinxql
SphinxQL query builder for Node.js. sphinxql package supports Manticore Search and Sphinx Search
Stars: ✭ 21 (-70.42%)
Mutual labels:  sphinx
sphinxcontrib-hdl-diagrams
Sphinx Extension which generates various types of diagrams from Verilog code.
Stars: ✭ 37 (-47.89%)
Mutual labels:  sphinx
choldgraf.github.io
Website
Stars: ✭ 33 (-53.52%)
Mutual labels:  sphinx
gui-python-gtk
Repositório criado para documentar e centralizar conteúdos, dicas, tutoriais e exemplos de código sobre a construção de interfaces com a linguagem de programação Python (PyGObject) e o toolkit gráfico Gtk 4.
Stars: ✭ 85 (+19.72%)
Mutual labels:  sphinx
sphinx press theme
A Sphinx-doc theme based on Vuepress
Stars: ✭ 113 (+59.15%)
Mutual labels:  sphinx
symbiflow-docs
FOSS Flow For FPGA
Stars: ✭ 163 (+129.58%)
Mutual labels:  sphinx
sphinxcontrib-django
This is a sphinx extension which improves the documentation of Django apps.
Stars: ✭ 37 (-47.89%)
Mutual labels:  sphinx
sphinx-jekyll-builder
sphinx builder that outputs jekyll compatible markdown files with frontmatter
Stars: ✭ 18 (-74.65%)
Mutual labels:  sphinx
sphinx-toolbox
Box of handy tools for Sphinx 🧰 📔
Stars: ✭ 55 (-22.54%)
Mutual labels:  sphinx
sphinxcontrib-programoutput
Sphinx extension for capturing program output
Stars: ✭ 29 (-59.15%)
Mutual labels:  sphinx
sphinx-hoverxref
Sphinx extension to show tooltips with content embedded when hover a reference.
Stars: ✭ 77 (+8.45%)
Mutual labels:  sphinx
sphinx-codeautolink
Automatic links from code examples to reference documentation
Stars: ✭ 41 (-42.25%)
Mutual labels:  sphinx
roll.urown.net
How to roll your own private self-hosted internet services.
Stars: ✭ 63 (-11.27%)
Mutual labels:  sphinx
moja global docs
Repository to host the moja global technical documentation
Stars: ✭ 35 (-50.7%)
Mutual labels:  sphinx
sphinx-server
Sphinx documentation Docker image with Python server and support for PlantUML and more.
Stars: ✭ 62 (-12.68%)
Mutual labels:  sphinx
sphinxcontrib-trio
Make Sphinx better at documenting Python functions and methods
Stars: ✭ 26 (-63.38%)
Mutual labels:  sphinx
pygments-pytest
A pygments lexer for pytest output
Stars: ✭ 23 (-67.61%)
Mutual labels:  sphinx
pandoc-doc-ja
Pandocユーザーズガイド日本語版(Pandoc 2.7.2+準拠)のリポジトリ by Sphinx
Stars: ✭ 19 (-73.24%)
Mutual labels:  sphinx
graygram-web
www.graygram.com
Stars: ✭ 16 (-77.46%)
Mutual labels:  sphinx
houdini additional python docs
🐍 Additional documentation of Houdini Python modules
Stars: ✭ 21 (-70.42%)
Mutual labels:  sphinx

Material Design HTML Theme for Sphinx

PyPI version CircleCI

Demo Document

Requirements

  • python
    • Sphinx

Quick Start

Install the latest version of sphinx_materialdesign_theme with pip.

pip install sphinx_materialdesign_theme

Add the following line to conf.py.

html_theme = 'sphinx_materialdesign_theme'

Html theme options

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
}

Developer's Tips

packaging

python setup.py sdist

install

pip install dist/sphinx_materialdesign_theme-${version}.tar.gz

Resister PyPI

python setup.py register sdist upload

Build Example's Document

sphinx-build -b html ./example ./_build -c ./example

License

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
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].