From c85c2f7535306b895a5b6c9dc6a96af63450e9f8 Mon Sep 17 00:00:00 2001 From: Tommi Virtanen Date: Tue, 30 Aug 2011 11:26:56 -0700 Subject: [PATCH] doc: Adjust how table of contents is presented. Signed-off-by: Tommi Virtanen --- doc/_templates/smarttoc.html | 13 +++++++++++++ doc/conf.py | 3 +++ doc/index.rst | 11 ++++------- 3 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 doc/_templates/smarttoc.html diff --git a/doc/_templates/smarttoc.html b/doc/_templates/smarttoc.html new file mode 100644 index 0000000000000..eb7444afae6bf --- /dev/null +++ b/doc/_templates/smarttoc.html @@ -0,0 +1,13 @@ +{# + Sphinx sidebar template: smart table of contents. + + Show a sidebar ToC that gives you a more global view of the + documentation, and not the confusing cur/prev/next that is the + default sidebar. + + The ToC will open & collapse automatically to show the part of the + hierarchy you are in. Top-level items will always be visible. + +#} +

{{ _('Table Of Contents') }}

+{{ toctree(maxdepth=-1) }} diff --git a/doc/conf.py b/doc/conf.py index b711c5247e14f..676e16a96002e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -16,6 +16,9 @@ html_favicon = 'favicon.ico' html_static_path = ['_static'] html_use_smartypants = True html_show_sphinx = False +html_sidebars = { + '**': ['smarttoc.html', 'searchbox.html'], + } # ugly kludge until breathe is distutils-friendly import sys; sys.path.append('../build-doc/breathe') diff --git a/doc/index.rst b/doc/index.rst index 8397157d781ae..1ddc09fbe1b89 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,10 +1,6 @@ -================================ - Ceph -- petabyte scale storage -================================ - - -Welcome to Ceph -=============== +================= + Welcome to Ceph +================= Ceph is a distributed network storage and file system with distributed metadata management and POSIX semantics. @@ -89,6 +85,7 @@ Table of Contents .. toctree:: :maxdepth: 3 + self tutorial architecture ops/index -- 2.39.5