4

I'm documenting my Python project using Sphinx tool and my HTML output currently looks like this:

As you can see the tool bar has "Navigation" heading with nothing under it. When I add the following code to my conf.py file, the HTML toolbar remains the same (with nothing under Navigation):

html_sidebars = {
'**': [
    'about.html',
    'navigation.html',
    'searchbox.html'
]}

Do I have to create some file on my own or am I doing something wrong?

My goal is for the HTML to look like this:

I assume it's the same issue as adding a logo to the HTML which I also couldn't create.

These are the contents of the index.rst file in my Sphinx project:

.. Sample documentation master file, created by
   sphinx-quickstart on Thu Jul  5 09:19:15 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Sample's documentation!
====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
bad_coder
  • 11,289
  • 20
  • 44
  • 72
Caffeine
  • 445
  • 1
  • 4
  • 16
  • 2
    Edit your question to show the content of your `index.rst`. You are likely missing a `toctree` entry or filenames under it. – Steve Piercy Jul 12 '18 at 21:04
  • And yeah, that file's table of contents (currently empty) is what goes into your side menu – Mad Physicist Jul 15 '18 at 04:27
  • Added the code. I read some docs on the toctree but still can't figure out how to insert a Navigation bar so it actually references to other places in the docs. It sounds to me like a task that includes heavy html building ? Because it is custom ? Or maybe I'm missing something and Sphinx generates that stuff for me ? – Caffeine Jul 15 '18 at 04:41
  • The toctree is empty. You need to add entries to it (the names of the other RST documents). See http://www.sphinx-doc.org/en/stable/markup/toctree.html – mzjn Jul 15 '18 at 09:38

0 Answers0