Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pdxjohnny opened this issue Jul 29, 2021 · 5 comments
Open

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

pdxjohnny opened this issue Jul 29, 2021 · 5 comments
Labels
community input needed! Help! We need your input on this issue!

Comments

@pdxjohnny
Copy link
Member

pdxjohnny commented Jul 29, 2021

Let's use thumbs up emojis to vote for comments / screenshots of themes we like

@pdxjohnny
Copy link
Member Author

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")

@pdxjohnny
Copy link
Member Author

image

Note, there is no left sidebar, which is concerning

@pdxjohnny pdxjohnny added the community input needed! Help! We need your input on this issue! label Jul 29, 2021
@mhash1m
Copy link
Contributor

mhash1m commented Jul 31, 2021

@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/

image

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

@pdxjohnny pdxjohnny changed the title docs: conf: html theme: Evaluate sphinx_material docs: conf: html theme: Evaluate new themes Jul 31, 2021
@pdxjohnny pdxjohnny pinned this issue Jul 31, 2021
@pdxjohnny pdxjohnny changed the title docs: conf: html theme: Evaluate new themes VOTE!: docs: conf: html theme: Evaluate new themes Jul 31, 2021
@programmer290399
Copy link
Collaborator

@programmer290399
Copy link
Collaborator

programmer290399 commented Oct 26, 2021

bf0a0bf7-899c-44b9-9efc-d4f44de45af1

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community input needed! Help! We need your input on this issue!
Projects
None yet
Development

No branches or pull requests

3 participants