alabaster icon indicating copy to clipboard operation
alabaster copied to clipboard

Navigation disappears when navigating to different document

Open Syntaf opened this issue 9 years ago • 6 comments
trafficstars

My navigation section is only displayed on my index.html page, navigating to any other page will leave the navigation sidebar blank. Anyone know what i'm doing wrong?

index.rst:

.. CALIPSO documentation master file, created by
   sphinx-quickstart on Tue Jun 09 15:49:16 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

============================================================
Welcome to the Visualization of Calipso Tool (VOCAL)!
============================================================

Everything you'll need to know from installation to developing the application can be found here!
 VOCAL aim's to have a very in depth doc page in order to promote open source development 
and allow for VOCAL to evolve as the users see fit. Refer to the side bar on the left to navigate 
about the doc page, and use the search button at the top corner if you're looking for specific areas.

.. toctree::

   overview
   installation
   gettingdata
   supporteddata
   tutorial
   dev/conventions
   dev/enviroment
   dev/docs
   dev/site
   doc/modules
   trouble/faq
   trouble/issuetracker
   trouble/contact

Generates img

Looks all great, but clicking any link leaves me with img

Where'd the navigation bar go? Do I need to specify something?

Syntaf avatar Jan 30 '16 18:01 Syntaf

That's pretty bizarre, nothing comes to mind offhand. If you can share your Sphinx source somebody (me, if I have time, or a good Samaritan otherwise) might be able to spelunk and see what's up.

Alternately, if you poke at my own Alabaster-using sites, maybe you'll spot something you're doing differently? E.g. https://github.com/pyinvoke/invoke/tree/master/sites/docs (rendered: http://docs.pyinvoke.org/en/0.12.2/) - it does some slightly off-spec things re: building dual www/doc sites, but the basic toctree and nav junk should be plain enough.

bitprophet avatar Feb 08 '16 06:02 bitprophet

Did you ever figure out a solution to this issue? I am producing the same error.

tkschuler avatar May 08 '19 19:05 tkschuler

It's an old question, but I had the same problem and I solved changing the order of the title levels:

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections

Index.rst has a title with = and overline =

If you are creating a new file overview.rst you might be consistent with the title order and use the next one, - and overline -.

victorako avatar Aug 26 '21 14:08 victorako

I run into the same problem and just can't fix it. One item in the navbar keeps on disappearing. Even if I have just plain text in it without any further formatting, it doesn't work. I can even its contents with the content of other (working) docs and it just fails.

My index.rst look like this:

.. toctree::
  
  dataset
  content
  network
  export
  credits

"credits" doesn't work. All other items do. I've never been so confused.

EDIT: I recreated the entire sphinx project, moved all pre-existing docs into the new project folder, rebuilt the source and now it works. Maybe it was some sort of version issue? I don't know.

stopopol avatar Jun 21 '22 12:06 stopopol

i experienced this. clicking on anything in the "index" on the left caused the 'second main header and its children' to disappear.

i rm -r everything in the build as well as /docs. i rebuild and repush. weirdly, i note that the .ipynb for the second header have been deleted

image

weirdly, i do not have this issue anymore. i dont know if there was a correlation, but it was weird enough that i share here.

plbremer avatar Jun 02 '23 02:06 plbremer

I had the same frustrating problem with some subsections disappearing when navigating in the document. The problem disappeared by removing excess "=" when defining the title:s in the sub-rst:s, only having the same number of "=" as the number of letters in the title above.

i.e., instead of

title
===========

I made sure to consistently use:

title
=====

Magically, the problem went away.

janoesth avatar Jun 21 '23 08:06 janoesth