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

Add the homepage back to the navigation #271

Merged
merged 1 commit into from Dec 16, 2014
Merged

Conversation

@d0ugal
Copy link
Member

@d0ugal d0ugal commented Dec 3, 2014

No description provided.

@d0ugal
Copy link
Member Author

@d0ugal d0ugal commented Dec 3, 2014

@tomchristie Interested in your input on this. My reasoning before was that if we add it, it is hard to remove it. However, I think now that is wrong.

  1. Without it in the nav, doing the TOC for the homepage is really hard. The Read The Docs theme feels weird on the homepage for example.
  2. If can be easily ignore with a simple {% if not page.is_homepage %}
@d0ugal
Copy link
Member Author

@d0ugal d0ugal commented Dec 3, 2014

This will close #236.

@tomchristie
Copy link
Contributor

@tomchristie tomchristie commented Dec 3, 2014

Not yet reviews if this should just already be in nav_items, or only in iter as per this fix.

@d0ugal
Copy link
Member Author

@d0ugal d0ugal commented Dec 3, 2014

hmm, yeah, I think it should be added to nav_items. Will update.

@d0ugal d0ugal force-pushed the d0ugal:add-homepage-to-nav branch from cff5f86 to 7eb21c0 Dec 4, 2014
Fixes #236
@d0ugal d0ugal force-pushed the d0ugal:add-homepage-to-nav branch from 7eb21c0 to bfdab5f Dec 4, 2014
@d0ugal d0ugal added this to the 0.12.0 milestone Dec 4, 2014
@d0ugal
Copy link
Member Author

@d0ugal d0ugal commented Dec 4, 2014

Ok, this seems pretty solid now. One thing to note, it is technically backwards incompatible as it will change what the theme outputs. In some cases, like in Django REST Framework, it will mean the Home nav item is displayed twice until the one manually added is removed.

@tomchristie Thoughts on this? Seem okay to do that in a 0.12 release?

@d0ugal
Copy link
Member Author

@d0ugal d0ugal commented Dec 10, 2014

@tomchristie Spotted the above question?

@tomchristie
Copy link
Contributor

@tomchristie tomchristie commented Dec 10, 2014

@d0ugal Yeah that's okay, tho probably worth pre-emptively tracking in a REST framework issue.
Also I never caught up on the source code highlighting so maybe open a ticket for that with whatever you suggested as the resolution for that. Would we also be in a position to switch the search for 0.12 away from the current google search.

(Apologies for the off-topic bits here)

@d0ugal
Copy link
Member Author

@d0ugal d0ugal commented Dec 10, 2014

See encode/django-rest-framework#2246 for the highlighting issue.

d0ugal added a commit that referenced this pull request Dec 16, 2014
Add the homepage back to the navigation
@d0ugal d0ugal merged commit 28b0937 into mkdocs:master Dec 16, 2014
1 check passed
1 check passed
continuous-integration/travis-ci The Travis CI build passed
Details
@d0ugal d0ugal deleted the d0ugal:add-homepage-to-nav branch Dec 16, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.