Update Sphinx version and versioning process
- Updated to newer Sphinx version
- Changed to use doc8 to check .rst files
- Added a dictionary (dict.txt) and spellchecking
- Reformatted and fixed issues that were found in the content
Change-Id: If7b35e01ee8be25dbbd1ecd0e67b264aa6cc2a94
diff --git a/conf.py b/conf.py
index 5437ef2..8692aca 100644
--- a/conf.py
+++ b/conf.py
@@ -72,11 +72,22 @@
'sphinxcontrib.packetdiag',
'sphinxcontrib.rackdiag',
'sphinxcontrib.seqdiag',
+ 'sphinxcontrib.spelling',
+ 'sphinx_multiversion',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
+# Text files with lists of words that shouldn't fail the spellchecker:
+spelling_word_list_filename=['dict.txt', ]
+
+# inlcude only the branches matching master and 1.x
+smv_branch_whitelist = r'^(master|1.*)$'
+
+# include all remote branches
+smv_remote_whitelist = r'^.*$'
+
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#