VOTE!: docs: conf: html theme: Evaluate new themes #1179

Activity

1. johnandersen777 commented on Jul 29, 2021

   

   johnandersen777

   on Jul 29, 2021

   Author

   More actions

   diff --git a/docs/conf.py b/docs/conf.py
   index a31b24ea4..5f28bc736 100644
   --- a/docs/conf.py
   +++ b/docs/conf.py
   @@ -103,7 +103,7 @@ nbsphinx_prolog = r"""
    # The theme to use for HTML and HTML Help pages.  See the documentation for
    # a list of builtin themes.
    #
   -html_theme = "sphinx_rtd_theme"
   +html_theme = "sphinx_material"
    
    html_context = {
        "github_user": "intel",
   @@ -113,6 +113,26 @@ html_context = {
        "display_github": True,
    }
    
   +# Material theme options (see theme.conf for more information)
   +html_theme_options = {
   +    # Set the name of the project to appear in the navigation.
   +    "nav_title": project,
   +    # Specify a base_url used to generate sitemap.xml. If not
   +    # specified, then no sitemap will be built.
   +    "base_url": f"https://{html_context['github_user']}.github.io/{html_context['github_repo']}",
   +    # Set the color and the accent color
   +    "color_primary": "#0071c5",
   +    "color_accent": "#86b3ca",
   +    # Set the repo location to get a badge with stats
   +    "repo_url": f"https://github.com/{html_context['github_user']}/{html_context['github_repo']}/",
   +    # Visible levels of the global TOC; -1 means unlimited
   +    "globaltoc_depth": 3,
   +    # If False, expand all TOC entries
   +    "globaltoc_collapse": False,
   +    # If True, show hidden TOC entries
   +    "globaltoc_includehidden": False,
   +}
   +
    
    def setup(app):
        app.add_js_file("copybutton.js")
2. johnandersen777 commented on Jul 29, 2021

   

   johnandersen777

   on Jul 29, 2021

   Author

   More actions

   

   Note, there is no left sidebar, which is concerning
3. johnandersen777

   added

   community input needed!Help! We need your input on this issue!Help! We need your input on this issue!

   on Jul 29, 2021
4. mhash1m commented on Jul 31, 2021

   

   mhash1m

   on Jul 31, 2021

   Last edited by mhash1m

   Contributor

   More actions

   @pdxjohnny We liked this theme by "Executable Book Project" and I remember finding it but I forgot to share or followup on it.
   I think this one is quite attractive and fulfills our needs.

   For reference: https://testbook.readthedocs.io/en/latest/

   

   Might be a good idea to post some other options and have an emoji vote here 😄

   👍React with 👍3Reacted by John, Saahil Ali and Hashim
5. johnandersen777

   changed the title [-]docs: conf: html theme: Evaluate sphinx_material[/-] [+]docs: conf: html theme: Evaluate new themes[/+] on Jul 31, 2021
6. johnandersen777

   pinned this issue on Jul 31, 2021
7. johnandersen777

   changed the title [-]docs: conf: html theme: Evaluate new themes[/-] [+]VOTE!: docs: conf: html theme: Evaluate new themes[/+] on Jul 31, 2021
8. programmer290399 commented on Sep 28, 2021

   

   programmer290399

   on Sep 28, 2021

   Contributor

   More actions

   From gitter , posted by @pdxjohnny : https://khuyentran1401.github.io/Efficient_Python_tricks_and_tools_for_data_scientists/Chapter3/Numpy.html
9. programmer290399 commented on Oct 26, 2021

   

   programmer290399

   on Oct 26, 2021

   Last edited by programmer290399

   Contributor

   More actions

   

   https://revitron.readthedocs.io/en/latest/get-started.html

   👍React with 👍2Reacted by John and Hashim