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

Fix navigation drawbacks in docs #3

Closed
bittner opened this issue Mar 21, 2016 · 4 comments
Closed

Fix navigation drawbacks in docs #3

bittner opened this issue Mar 21, 2016 · 4 comments
Labels

Comments

@bittner
Copy link
Member

bittner commented Mar 21, 2016

The documentation has a substantial drawback when it comes to navigating through content.

Problem example

See the Contributing chapter. How do you get back to the welcome page, for example?

This issue seems to be inherent to the Alabaster theme. Other projects have the same problem, see e.g. the behave docs, but it's less relevant there because the docs have the behave "logo" (the image with the words box) that takes you home. We should probably have something similar.

  • Can we fix the scarce navigation via some configuration switch? (Sphinx, Alabaster)
  • We should probably come up with a (Pony) logo and add it as a "home link" to the docs.

Logo ideas

"Given a pony, when I run behave with behave-django, then my project has awesome tests."

@bittner bittner changed the title Fix navigation drawbacks in documentation, create a logo Fix navigation drawbacks in docs, Create a logo Mar 21, 2016
@jenisys
Copy link
Member

jenisys commented Mar 22, 2016

@bittner
Maybe sphinx-bootstrap-theme solves these problems (in addition to using a logo).
The title-bar is always present. Therefore, you always have a link to the master-page.
SEE ALSO: https://github.com/ryan-roemer/sphinx-bootstrap-theme

EXAMPLE:
behave example_docs_header

@bittner
Copy link
Member Author

bittner commented Aug 23, 2016

The Alabaster documentation mentions a few options that may fix the issue (apart from the logo, apparently):

  • show_related = True
  • extra_nav_links = { ... }

Optionally,

  • fixed_sidebar = True may also be nice for the lengthy Usage page.

They need to be added to the html_theme_options dict, IIUC. A code example is available from the Alabaster docs source.

@mixxorz Can you try whether these options help to create a more meaningful navigation in the sidebar?

@bittner bittner changed the title Fix navigation drawbacks in docs, Create a logo Fix navigation drawbacks in docs Aug 24, 2016
@bittner
Copy link
Member Author

bittner commented Aug 24, 2016

I've moved the "create logo" part of this issue to a separate issue, so we can close this one as soon as PR #21 is merged and the updated docs are released.

@bittner
Copy link
Member Author

bittner commented Aug 27, 2016

Fixed via #21.

@bittner bittner closed this as completed Aug 27, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants