openstack/openstack-manuals
Code Issues Proposed changes

[Contributor Guide] Add glossary

Browse Source 
* 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
This commit is contained in:
KATO Tomoyuki 2015-10-22 20:22:22 +09:00
parent 9b7e1566ce
commit cf757faa04
4 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/contributor-guide/source/common Symbolic link
View File

@ -0,0 +1 @@
../../common-rst/

5
doc/contributor-guide/source/conf.py
View File

@ -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.

2
doc/contributor-guide/source/index.rst
View File

@ -30,6 +30,8 @@ Contents
tools_and_content_overview.rst
cherry-pick.rst
common/glossary.rst
Search in this guide
~~~~~~~~~~~~~~~~~~~~

3
doc/contributor-guide/source/rst-conv/inline-markups.rst
View File

@ -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