summaryrefslogtreecommitdiffstats
path: root/docs/smsummary.rst
blob: 13e0e4563d8f626de5719f9cd25ccb112c5f6754 (plain)
1
2
3
4
5
6
7
8
9
10
.. This work is licensed under a Creative Commons Attribution 4.0
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.

Contributing Submodule Summary
==============================

.. code-block:: console
   
.. literalinclude:: _static/smsummary.out
class="na">whitelist_externals = echo git sh [testenv:local] basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = git submodule update --depth 100 --init sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo git [testenv:docs-linkcheck] basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = echo "Link Checking not enforced" #commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck whitelist_externals = echo [testenv:spellcheck] basepython = python3 deps = -r{toxinidir}/etc/requirements.txt sphinxcontrib-spelling commands = sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck