diff --git a/README.md b/README.md index 481f9b960..c0214fa78 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + Light Gradient Boosting Machine =============================== diff --git a/docs/FAQ.rst b/docs/FAQ.rst index 77c1bbe4f..f0bcc3fbb 100644 --- a/docs/FAQ.rst +++ b/docs/FAQ.rst @@ -198,6 +198,11 @@ This is a known issue of CMake when using MinGW. The easiest solution is to run See `Microsoft/LightGBM#3060 `__ for more details. +15. Where can I find LightGBM's logo to use it in my presentation? +------------------------------------------------------------------ + +You can find LightGBM's logo in different file formats and resolutions `here `__. + ------ R-package diff --git a/docs/_static/images/favicon.ico b/docs/_static/images/favicon.ico new file mode 100644 index 000000000..7aa6981ad Binary files /dev/null and b/docs/_static/images/favicon.ico differ diff --git a/docs/conf.py b/docs/conf.py index 3dfbf1b85..ce4830f03 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,6 +100,15 @@ project = 'LightGBM' copyright = '%s, Microsoft Corporation' % str(datetime.datetime.now().year) author = 'Microsoft Corporation' +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = os.path.join(CURR_PATH, 'logo', 'LightGBM_logo_grey_text.svg') + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = os.path.join(CURR_PATH, '_static', 'images', 'favicon.ico') + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -152,6 +161,7 @@ html_theme = 'sphinx_rtd_theme' # documentation. html_theme_options = { 'includehidden': False, + 'logo_only': True, } # Add any paths that contain custom static files (such as style sheets) here, @@ -164,6 +174,12 @@ html_static_path = ['_static'] # Output file base name for HTML help builder. htmlhelp_basename = 'LightGBMdoc' +# -- Options for LaTeX output --------------------------------------------- + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = os.path.join(CURR_PATH, 'logo', 'LightGBM_logo_black_text_small.png') + def generate_doxygen_xml(app): """Generate XML documentation for C API by Doxygen. diff --git a/docs/index.rst b/docs/index.rst index fd2a29fd3..2e86c8a77 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,12 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. image:: ./logo/LightGBM_logo_black_text.svg + :align: center + :width: 600 + +| + Welcome to LightGBM's documentation! ==================================== diff --git a/docs/logo/LightGBM_logo.cdr b/docs/logo/LightGBM_logo.cdr new file mode 100644 index 000000000..b22abf231 Binary files /dev/null and b/docs/logo/LightGBM_logo.cdr differ diff --git a/docs/logo/LightGBM_logo_black_text.svg b/docs/logo/LightGBM_logo_black_text.svg new file mode 100644 index 000000000..a3411280a --- /dev/null +++ b/docs/logo/LightGBM_logo_black_text.svg @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logo/LightGBM_logo_black_text_huge.png b/docs/logo/LightGBM_logo_black_text_huge.png new file mode 100644 index 000000000..508028ba3 Binary files /dev/null and b/docs/logo/LightGBM_logo_black_text_huge.png differ diff --git a/docs/logo/LightGBM_logo_black_text_large.png b/docs/logo/LightGBM_logo_black_text_large.png new file mode 100644 index 000000000..17d963497 Binary files /dev/null and b/docs/logo/LightGBM_logo_black_text_large.png differ diff --git a/docs/logo/LightGBM_logo_black_text_medium.png b/docs/logo/LightGBM_logo_black_text_medium.png new file mode 100644 index 000000000..ca612131f Binary files /dev/null and b/docs/logo/LightGBM_logo_black_text_medium.png differ diff --git a/docs/logo/LightGBM_logo_black_text_small.png b/docs/logo/LightGBM_logo_black_text_small.png new file mode 100644 index 000000000..3e1d34cf3 Binary files /dev/null and b/docs/logo/LightGBM_logo_black_text_small.png differ diff --git a/docs/logo/LightGBM_logo_black_text_tiny.png b/docs/logo/LightGBM_logo_black_text_tiny.png new file mode 100644 index 000000000..e68151502 Binary files /dev/null and b/docs/logo/LightGBM_logo_black_text_tiny.png differ diff --git a/docs/logo/LightGBM_logo_grey_text.svg b/docs/logo/LightGBM_logo_grey_text.svg new file mode 100644 index 000000000..1a9e42142 --- /dev/null +++ b/docs/logo/LightGBM_logo_grey_text.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logo/LightGBM_logo_grey_text_huge.png b/docs/logo/LightGBM_logo_grey_text_huge.png new file mode 100644 index 000000000..49fcd7937 Binary files /dev/null and b/docs/logo/LightGBM_logo_grey_text_huge.png differ diff --git a/docs/logo/LightGBM_logo_grey_text_large.png b/docs/logo/LightGBM_logo_grey_text_large.png new file mode 100644 index 000000000..57a02eb86 Binary files /dev/null and b/docs/logo/LightGBM_logo_grey_text_large.png differ diff --git a/docs/logo/LightGBM_logo_grey_text_medium.png b/docs/logo/LightGBM_logo_grey_text_medium.png new file mode 100644 index 000000000..776d4ea4d Binary files /dev/null and b/docs/logo/LightGBM_logo_grey_text_medium.png differ diff --git a/docs/logo/LightGBM_logo_grey_text_small.png b/docs/logo/LightGBM_logo_grey_text_small.png new file mode 100644 index 000000000..700509cc5 Binary files /dev/null and b/docs/logo/LightGBM_logo_grey_text_small.png differ diff --git a/docs/logo/LightGBM_logo_grey_text_tiny.png b/docs/logo/LightGBM_logo_grey_text_tiny.png new file mode 100644 index 000000000..fda57123f Binary files /dev/null and b/docs/logo/LightGBM_logo_grey_text_tiny.png differ diff --git a/docs/logo/LightGBM_logo_no_text.svg b/docs/logo/LightGBM_logo_no_text.svg new file mode 100644 index 000000000..c9640de35 --- /dev/null +++ b/docs/logo/LightGBM_logo_no_text.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + diff --git a/docs/logo/LightGBM_logo_no_text_huge.png b/docs/logo/LightGBM_logo_no_text_huge.png new file mode 100644 index 000000000..fd67adc59 Binary files /dev/null and b/docs/logo/LightGBM_logo_no_text_huge.png differ diff --git a/docs/logo/LightGBM_logo_no_text_large.png b/docs/logo/LightGBM_logo_no_text_large.png new file mode 100644 index 000000000..9b6c77a66 Binary files /dev/null and b/docs/logo/LightGBM_logo_no_text_large.png differ diff --git a/docs/logo/LightGBM_logo_no_text_medium.png b/docs/logo/LightGBM_logo_no_text_medium.png new file mode 100644 index 000000000..55f22e541 Binary files /dev/null and b/docs/logo/LightGBM_logo_no_text_medium.png differ diff --git a/docs/logo/LightGBM_logo_no_text_small.png b/docs/logo/LightGBM_logo_no_text_small.png new file mode 100644 index 000000000..0241e8eb8 Binary files /dev/null and b/docs/logo/LightGBM_logo_no_text_small.png differ diff --git a/docs/logo/LightGBM_logo_no_text_tiny.png b/docs/logo/LightGBM_logo_no_text_tiny.png new file mode 100644 index 000000000..513d76e8c Binary files /dev/null and b/docs/logo/LightGBM_logo_no_text_tiny.png differ diff --git a/logo/logo_black_font.png b/logo/logo_black_font.png deleted file mode 100644 index f2850bf90..000000000 Binary files a/logo/logo_black_font.png and /dev/null differ diff --git a/logo/logo_non_font.png b/logo/logo_non_font.png deleted file mode 100644 index 418814898..000000000 Binary files a/logo/logo_non_font.png and /dev/null differ diff --git a/logo/logo_white_font.png b/logo/logo_white_font.png deleted file mode 100644 index ec53fb59b..000000000 Binary files a/logo/logo_white_font.png and /dev/null differ