From 8cdb92b5bf96e7ce7384635e0ff1640bf9639d96 Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Fri, 15 Nov 2013 17:35:34 +0100 Subject: [PATCH 1/3] Add 'full table of contents' page to docs --- doc/conf.py | 2 +- doc/contents.rst | 20 ++++++++++++++++++++ doc/index.rst | 16 ---------------- 3 files changed, 21 insertions(+), 17 deletions(-) create mode 100644 doc/contents.rst diff --git a/doc/conf.py b/doc/conf.py index 22e1049600a..2dba5c2446c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -77,7 +77,7 @@ #source_encoding = 'utf-8' # The master toctree document. -master_doc = 'index' +master_doc = 'contents' # General information about the project. project = u'CKAN' diff --git a/doc/contents.rst b/doc/contents.rst new file mode 100644 index 00000000000..b81012c09f9 --- /dev/null +++ b/doc/contents.rst @@ -0,0 +1,20 @@ +====================== +Full table of contents +====================== + +.. toctree:: + :maxdepth: 2 + + index + installing + upgrading + getting-started + features + extensions/index + theming + api + contributing + test + configuration + changelog + diff --git a/doc/index.rst b/doc/index.rst index e0167318ecb..736db5bce43 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -29,19 +29,3 @@ advanced documentation last: * Finally, :doc:`configuration` and :doc:`changelog` are **reference** docs covering CKAN's config file options and the differences between CKAN releases. - -.. toctree:: - :hidden: - :maxdepth: 2 - - installing - upgrading - getting-started - features - extensions/index - theming - api - contributing - test - configuration - changelog From 55732cba210d84e7bf758c1468204488b74d198a Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Fri, 15 Nov 2013 17:38:14 +0100 Subject: [PATCH 2/3] Docs: remove depth limit from full toc --- doc/contents.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/contents.rst b/doc/contents.rst index b81012c09f9..c80e815b114 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -3,7 +3,6 @@ Full table of contents ====================== .. toctree:: - :maxdepth: 2 index installing From d322b015bde73ceb1b484652bf56ccf63b6efd9e Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Fri, 15 Nov 2013 18:07:59 +0100 Subject: [PATCH 3/3] Fix the docs PDF build --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 2dba5c2446c..36556e916e1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -234,7 +234,7 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'ComprehensiveKnowledgeArchiveNetworkCKAN.tex', ur'Comprehensive Knowledge Archive Network (CKAN) Developer Documentation', + ('contents', 'ComprehensiveKnowledgeArchiveNetworkCKAN.tex', ur'Comprehensive Knowledge Archive Network (CKAN) Developer Documentation', ur'Open Knowledge Foundation', 'manual'), ]