aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Fehrle2018-10-03 18:16:14 -0700
committerThéo Zimmermann2018-10-10 19:34:04 +0200
commit7489829eff2b36b15694a7f06122fc825905bba6 (patch)
tree2ffb33fe39056a14afb63ffc9ea76fd6e2ed05df
parent3a0a9c27dad3e3177416d703b996c699c7a0542c (diff)
Include all menu entries in the menu/short TOC so that users can view
menu options for all chapters without having to load a new chapter. Change "Introcution" title to "Introduction and Contents"
-rw-r--r--Makefile.doc2
-rwxr-xr-xdoc/sphinx/conf.py5
-rw-r--r--doc/sphinx/index.html.rst6
-rw-r--r--doc/sphinx/introduction.rst4
4 files changed, 9 insertions, 8 deletions
diff --git a/Makefile.doc b/Makefile.doc
index 1184cc186b..9e6ec4955a 100644
--- a/Makefile.doc
+++ b/Makefile.doc
@@ -10,7 +10,7 @@
# Makefile for the Coq documentation
-# Read INSTALL.doc to learn about the dependencies
+# Read doc/README.md to learn about the dependencies
# The main entry point :
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index 71f01cbb17..d98b8641e9 100755
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -193,8 +193,9 @@ html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
-
+html_theme_options = {
+ 'collapse_navigation': False
+}
html_context = {
'display_github': True,
'github_user': 'coq',
diff --git a/doc/sphinx/index.html.rst b/doc/sphinx/index.html.rst
index cf12b57414..a4ab4ad070 100644
--- a/doc/sphinx/index.html.rst
+++ b/doc/sphinx/index.html.rst
@@ -1,13 +1,13 @@
.. _introduction:
==========================
-Introduction
+Introduction and Contents
==========================
.. include:: introduction.rst
-Table of contents
------------------
+Contents
+--------
.. toctree::
:caption: Indexes
diff --git a/doc/sphinx/introduction.rst b/doc/sphinx/introduction.rst
index 5bb7bf542c..bcdf3277ad 100644
--- a/doc/sphinx/introduction.rst
+++ b/doc/sphinx/introduction.rst
@@ -44,7 +44,7 @@ are processed from a file.
.. seealso:: :ref:`thecoqcommands`.
How to read this book
-=====================
+---------------------
This is a Reference Manual, so it is not intended for continuous reading.
We recommend using the various indexes to quickly locate the documentation
@@ -90,7 +90,7 @@ Nonetheless, the manual has some structure that is explained below.
solvers and tactics. See the table of contents for a complete list.
List of additional documentation
-================================
+--------------------------------
This manual does not contain all the documentation the user may need
about |Coq|. Various informations can be found in the following documents: