From 16e76faba397a085a92eb3d1588b92ff456af045 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Mon, 26 Feb 2018 11:49:23 +0000 Subject: [PATCH] doc: Add "config" to usage guide Signed-off-by: Stephen Finucane --- doc/contents.rst | 2 +- doc/{config.rst => usage/configuration.rst} | 2 +- doc/usage/quickstart.rst | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) rename doc/{config.rst => usage/configuration.rst} (99%) diff --git a/doc/contents.rst b/doc/contents.rst index 4a8a4d947..77dcf6c42 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -11,11 +11,11 @@ Sphinx documentation contents usage/quickstart usage/restructuredtext/index usage/markdown + usage/configuration intro man/index builders - config intl theming setuptools diff --git a/doc/config.rst b/doc/usage/configuration.rst similarity index 99% rename from doc/config.rst rename to doc/usage/configuration.rst index 27d84b293..02df9215d 100644 --- a/doc/config.rst +++ b/doc/usage/configuration.rst @@ -2485,5 +2485,5 @@ Options for the C++ domain Example of configuration file ============================= -.. literalinclude:: _static/conf.py.txt +.. literalinclude:: ../_static/conf.py.txt :language: python diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst index adda610ab..e90b993c6 100644 --- a/doc/usage/quickstart.rst +++ b/doc/usage/quickstart.rst @@ -236,8 +236,8 @@ so on. The file is saved in UTF-8 by default, as indicated by the encoding declaration in the first line. If you use non-ASCII characters in any string value, you need to use Python Unicode strings (like ``project = u'Exposé'``). -|more| See :ref:`build-config` for documentation of all available config -values. +|more| See :doc:`/usage/configuration` for documentation of all available +config values. .. todo:: Move this entire doc to a different section