add relbar (breadcrumbs)

[shiumachi]

This patch introduces relbar macro (breadcrumbs).
The macro is turned off by default.
If user want to turn on this feature, set 'relbar_enable' to 'true'.

[ryan-roemer]

Indentation looks off here...

[shiumachi]

Thanks. I've fixed it.

[ryan-roemer]

Can you post screenshots of this in the demo?

[shiumachi]

Here is the screenshot:

If you want to include this into repository, please let me know where is the best place to put the image.

I've found that a new page is needed to show this feature.
I'll add the page into the PR.

[ryan-roemer]

@shiumachi -- Thanks for the additional work. I'm actually out of the country, so won't get a chance to try this out until a week from now. So if I'm out of touch until then it's because of that and I'll pick things up after. Thanks again!

[shiumachi]

np, no need to hurry.
Enjoy your trip!

[ryan-roemer]

@shiumachi -- Can you split this into two options or a different type of configuration to allow top and / or bottom relbars to be shown?

@russell -- Any thoughts on this one?

[russell]

@ryan-roemer it does seem more naturall to have a relbar at the top only. I don't think it really matters if it's one opiton or two. Probably one option would be more clear to the user.

[shiumachi]

Hi @ryan-roemer and @russell,

IMO current option would be enough.
User can override relbar1 or relbar2 in layout.html to remove top or bottom relbar:

{% block relbar2 %}{% endblock %}

This is the same way which is mentioned in Sphinx official document.
http://sphinx-doc.org/templating.html

But if you guys think it's better to have two option for relbars, I can put it in my patch.
There is two way:

a) split into two options relbar1_enable and relbar2_enable
b) add new option relbar_position which can be set to top, bottom, or both (default).

[ryan-roemer]

Hi @shiumachi -- I like the idea of not having to override the base template to disable this new functionality. Let's go for:

• add new option relbar_position which can be set to top, bottom, both, none. And make none the default.

/cc @russell

[piernik]

Is this implemented?

[ryan-roemer]

@piernik you're looking at the exact current state of implementation right here. If you would like to open a new PR that is

• caught up to current master
• implements my final requested tweaks at add relbar (breadcrumbs) #102 (comment)

that would be awesome!

[piernik]

sorry but I don't know anything about shipx and/or python and/or github :/