Skip to content

Conversation

shawnlinxl
Copy link
Contributor

@shawnlinxl shawnlinxl commented Jun 25, 2020

  1. In the user guide, I've added a section for adding logo:
  • this part might be redundant, as it's already in Sphinx's documentation.
  • my argument for still having it is some user may not be fluent enough in Sphinx, while still want to use pydata sphinx theme, which is a great theme. Without setting the logo, the navbar actually becomes not that great looking. By being explicit about the logo configuration in user guide, it makes it easier for user to find this setting.
  1. Also, I've added additional instruction for including "edit this page". I believe this is necessary for edit this page to work:
html_theme_options = {
    "use_edit_page_button": True,
}

@shawnlinxl shawnlinxl changed the title Add logo config, and complete edit page Add logo config, and complete edit page to user guide Jun 25, 2020
@jorisvandenbossche
Copy link
Member

this part might be redundant, as it's already in Sphinx's documentation.

It's indeed certainly useful for people less familiar with sphinx!

Copy link
Member

@jorisvandenbossche jorisvandenbossche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@jorisvandenbossche jorisvandenbossche merged commit d697ef0 into pydata:master Jun 25, 2020
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

Successfully merging this pull request may close these issues.

2 participants