From 7a4c7c49441395a45e85f5649856ac3982081316 Mon Sep 17 00:00:00 2001 From: Darren Slatten Date: Sat, 27 Jul 2013 20:09:42 -0500 Subject: Added the `:orphan:` file-wide metadata field The :orphan: field suppresses the Sphinx error that occurs when a file in the source directory doesn't appear in a `toctree` directive. --- docs/foreword.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/foreword.rst b/docs/foreword.rst index aa8d7c77b..cc8271bdf 100644 --- a/docs/foreword.rst +++ b/docs/foreword.rst @@ -1,3 +1,5 @@ +:orphan: + Foreword ======== -- cgit v1.2.3 From 133323b00defc9a8a6fbd8247cbb7125c2377f91 Mon Sep 17 00:00:00 2001 From: Darren Slatten Date: Sat, 27 Jul 2013 20:14:04 -0500 Subject: Removed `foreword.rst` from hidden `toctree` The `foreword.rst` file was used in printed versions, but currently it is not being used, so it shouldn't appear in any `toctree` directives. --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 22b27039c..52b30df45 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -223,6 +223,5 @@ Index and Glossary :hidden: glossary - foreword.rst latexindex.rst -- cgit v1.2.3 From 0ed2c8f00d31caa224875a51b6a7723098b570ef Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 28 Jul 2013 14:06:49 -0400 Subject: use :orphan: for latexindex too --- docs/index.rst | 4 ---- docs/latexindex.rst | 2 ++ 2 files changed, 2 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 52b30df45..5dfbbce1e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -216,12 +216,8 @@ Index and Glossary * :ref:`genindex` * :ref:`search` - -.. add glossary, foreword, and latexindex in a hidden toc to avoid warnings - .. toctree:: :hidden: glossary - latexindex.rst diff --git a/docs/latexindex.rst b/docs/latexindex.rst index 83641d8b3..c0cfb7696 100644 --- a/docs/latexindex.rst +++ b/docs/latexindex.rst @@ -1,3 +1,5 @@ +:orphan: + .. _latexindex: ================================================= -- cgit v1.2.3