Skip to content

Feature Request, add nosidebar and nonavbar options #262

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

Closed
j9ac9k opened this issue Oct 6, 2020 · 4 comments
Closed

Feature Request, add nosidebar and nonavbar options #262

j9ac9k opened this issue Oct 6, 2020 · 4 comments

Comments

@j9ac9k
Copy link
Contributor

j9ac9k commented Oct 6, 2020

Hello pydata-sphinx-theme maintainers!

Love the project! I'm using the theme in a slightly different manner, I'm specifically using it to build docsets for dash and the various derivates (zeal comes to mind).

Here is a screenshot!

image

To make it work in such a manner, I had to manually add some CSS to hide the sidebar and the navbar up top (which you may notice that there is still a lot of empty space at the top, but I'm not too concerned about that).

It would be great if there was an option to just hide the sidebar and navbars so the html output could be embedded in such a way.

Thanks for everyones work on this, this is an awesome project!

@jorisvandenbossche
Copy link
Member

Note that for hiding the sidebar (not yet navbar), this can now be done by setting this sphinx option in conf.py (after #263):

html_sidebars = {
    "pagename": [],
}

For doing this for all pages, you can use ** instead of pagename.

@choldgraf
Copy link
Collaborator

choldgraf commented Nov 2, 2020

@jorisvandenbossche what do you think about following the same pattern for the navbar? Something like html_navbar with default options like:

html_navbar = {
  "**": ["logo.html", "navbar-menu.html", "social.html"]
}

and it could be extended (or excluded) in the same way as the sidebar?

Then we could let people add, e.g., the search bar to the navbar via this mechanism rather than having "switch" configs like we currently use

@12rambau
Copy link
Collaborator

From what I understand we are moving away from no-header documentation should we close this issue then ?

@choldgraf
Copy link
Collaborator

well we do already have navbar_start / center / end, now, and sidebars will be hidden if there's no content in them, so I think that functionality is nearly there. Regarding nosidebar and nonavbar...I think we could consider this one resolved and we can open an issue with more specific change requests if they are still there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants