Creating a html navigation bar within Sphinx

759 views
Skip to first unread message

Hallam Curry

unread,
Feb 14, 2018, 7:23:24 PM2/14/18
to sphinx-users

Hello! I previously posted the below question to github and was asked to move it to this group. Any help is much appreciated:


Hi, I recently put forward an issue on here about my html pages which was fixed, many thanks.


However, I've now come across something I'm not sure about. I am wanting to add a horizontal navigation bar to the top of my html pages that are created with Sphinx, however, due to the fact that I can't edit the html files themselves since Sphinx ignores this on 'make html', is there anyway i can do this without raw html code?

I have the css for 'topnav' and 'topnav2' ready to go, it's just I'm not sure if its actually possible to do this without writing the html in myself, which is no good.

I am using the sphinx_rtd_theme with a custom CSS file if that helps at all?


Thanks!


Environment info

OS: MacOS High Sierra
Python version: 2.7.10
Sphinx version: 1.7.0b1
Extra tools: Google Chrome

Aaron Carlisle

unread,
Feb 15, 2018, 1:58:10 AM2/15/18
to sphinx...@googlegroups.com
Hi,

I looked into this and this needs a modification to the theme to easily be able to extend the theme to support this.
Being a member of the team I submitted a PR: https://github.com/rtfd/sphinx_rtd_theme/pull/577
With this, you should be able to easily extend the HTML file http://www.sphinx-doc.org/en/stable/templating.html
with the HTML code for the navbar or might be possible with a call to the toctree.

Anyway, this should help.

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscribe@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.



--
Aaron Carlisle

Picture taker | Bit cruncher | Pixel pusher | Document writer |
Project administrator for the Blender 3D Documentation Project

Hallam Curry

unread,
Feb 15, 2018, 6:08:26 AM2/15/18
to sphinx-users
thanks :)


On Thursday, 15 February 2018 06:58:10 UTC, Aaron Carlisle wrote:
Hi,

I looked into this and this needs a modification to the theme to easily be able to extend the theme to support this.
Being a member of the team I submitted a PR: https://github.com/rtfd/sphinx_rtd_theme/pull/577
With this, you should be able to easily extend the HTML file http://www.sphinx-doc.org/en/stable/templating.html
with the HTML code for the navbar or might be possible with a call to the toctree.

Anyway, this should help.
On Wed, Feb 14, 2018 at 2:12 PM, Hallam Curry <hallamc...@gmail.com> wrote:

Hello! I previously posted the below question to github and was asked to move it to this group. Any help is much appreciated:


Hi, I recently put forward an issue on here about my html pages which was fixed, many thanks.


However, I've now come across something I'm not sure about. I am wanting to add a horizontal navigation bar to the top of my html pages that are created with Sphinx, however, due to the fact that I can't edit the html files themselves since Sphinx ignores this on 'make html', is there anyway i can do this without raw html code?

I have the css for 'topnav' and 'topnav2' ready to go, it's just I'm not sure if its actually possible to do this without writing the html in myself, which is no good.

I am using the sphinx_rtd_theme with a custom CSS file if that helps at all?


Thanks!


Environment info

OS: MacOS High Sierra
Python version: 2.7.10
Sphinx version: 1.7.0b1
Extra tools: Google Chrome

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.

To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
Reply all
Reply to author
Forward
0 new messages