From cf757faa04bac2973ccc9bb51bb48d2e3b6d5df3 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Thu, 22 Oct 2015 20:22:22 +0900 Subject: [PATCH] [Contributor Guide] Add glossary * add output example of glossary term directive * add common directory for glossary * configure exclude_patterns for the unnecessary files Change-Id: I8c6057246ed03110e30b0693af8cdecb2c66d589 Depends-On: I08568fb37755109552edf9692b8f259660550a69 Implements: blueprint docs-contributor-guide --- doc/contributor-guide/source/common | 1 + doc/contributor-guide/source/conf.py | 5 ++++- doc/contributor-guide/source/index.rst | 2 ++ doc/contributor-guide/source/rst-conv/inline-markups.rst | 3 ++- 4 files changed, 9 insertions(+), 2 deletions(-) create mode 120000 doc/contributor-guide/source/common diff --git a/doc/contributor-guide/source/common b/doc/contributor-guide/source/common new file mode 120000 index 0000000000..03b5b059b0 --- /dev/null +++ b/doc/contributor-guide/source/common @@ -0,0 +1 @@ +../../common-rst/ \ No newline at end of file diff --git a/doc/contributor-guide/source/conf.py b/doc/contributor-guide/source/conf.py index 6ec6fb0ac1..f728a268b4 100644 --- a/doc/contributor-guide/source/conf.py +++ b/doc/contributor-guide/source/conf.py @@ -94,7 +94,10 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag, # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +exclude_patterns = ['common/app_support.rst', 'common/cli*', 'common/nova*', + 'common/get_started*', 'common/dashboard*', + 'common/conventions.rst', 'common/log_in_dashboard.rst'] + # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/contributor-guide/source/index.rst b/doc/contributor-guide/source/index.rst index b26ed51012..561043647e 100644 --- a/doc/contributor-guide/source/index.rst +++ b/doc/contributor-guide/source/index.rst @@ -30,6 +30,8 @@ Contents tools_and_content_overview.rst cherry-pick.rst + common/glossary.rst + Search in this guide ~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/contributor-guide/source/rst-conv/inline-markups.rst b/doc/contributor-guide/source/rst-conv/inline-markups.rst index d4f7f68472..b86d4418f7 100644 --- a/doc/contributor-guide/source/rst-conv/inline-markups.rst +++ b/doc/contributor-guide/source/rst-conv/inline-markups.rst @@ -89,7 +89,8 @@ A term that appears in the glossary. +------------------------+---------------------------------------------------+ | **Syntax** | ``:term:`bare``` | +------------------------+---------------------------------------------------+ -| **Example of output** | | +| **Example of output** | Upload the image to the Image service using | +| | the :term:`bare` container format. | +------------------------+---------------------------------------------------+ GUI element