summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitreview1
-rw-r--r--docs/conf.py58
-rw-r--r--docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst2
-rw-r--r--docs/guides/onap-user/vfw-design-tutorial/index.rst91
-rw-r--r--docs/release/index.rst45
-rw-r--r--docs/spelling_wordlist.txt (renamed from docs/validwords.txt)10
-rw-r--r--docs/tox.ini44
-rw-r--r--etc/requirements.txt9
-rw-r--r--tox.ini25
9 files changed, 151 insertions, 134 deletions
diff --git a/.gitreview b/.gitreview
index c088dd69b..d80d2f77a 100644
--- a/.gitreview
+++ b/.gitreview
@@ -2,3 +2,4 @@
host=gerrit.onap.org
port=29418
project=doc.git
+defaultbranch=guilin
diff --git a/docs/conf.py b/docs/conf.py
index f2e5a7a16..11f46b935 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,3 +1,4 @@
+from docutils.parsers.rst import directives
from docs_conf.conf import *
branch = 'guilin'
@@ -22,12 +23,15 @@ intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_
intersphinx_mapping['onap-clamp'] = ('{}/onap-clamp/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = (
+ '{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-holmes-engine-management'] = ('{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-holmes-engine-management'] = (
+ '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-holmes-rule-management'] = (
+ '{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None)
@@ -36,13 +40,16 @@ intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.for
intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oom-platform-cert-service'] = ('{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-oom-platform-cert-service'] = (
+ '{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ('{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = (
+ '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ('{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-sdc-sdc-distribution-client'] = (
+ '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None)
@@ -56,7 +63,6 @@ intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%
# Frankfurt
branch = 'frankfurt'
-intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
@@ -64,37 +70,57 @@ intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % bra
# Latest
branch = 'latest'
+intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-ccsdk-platform-plugins'] = ('{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-ccsdk-platform-plugins'] = (
+ '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ('{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-modeling-toscaparsers'] = ('{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = (
+ '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-modeling-toscaparsers'] = (
+ '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-music-distributed-kv-store'] = ('{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-music-distributed-kv-store'] = (
+ '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-oom-offline-installer'] = (
+ '{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None)
-intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ('{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
+intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = (
+ '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None)
intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None)
+linkcheck_ignore = [
+ 'about:config',
+ # this URL is not directly reachable and must be configured in the system hosts file.
+ 'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
+ # anchor issues
+ 'https://docs.onap.org/projects/onap-integration/en/guilin/docs_usecases_release.html#.*',
+ 'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
+ 'https://docs.onap.org/projects/onap-integration/en/guilin/docs_robot.html#docs-robot',
+ 'https://docs.onap.org/projects/onap-integration/en/guilin/docs_usecases_release.html#docs-usecases-release',
+ 'https://docs.onap.org/projects/onap-integration/en/guilin/docs_usecases.html#docs-usecases',
+ 'https://docs.onap.org/projects/onap-integration/en/guilin/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
+]
+
+
html_last_updated_fmt = '%d-%b-%y %H:%M'
-def setup(app):
- app.add_stylesheet("css/ribbon.css")
+def setup(app):
+ app.add_css_file("css/ribbon.css")
-from docutils.parsers.rst import directives
needs_extra_options = {
"target": directives.unchanged,
diff --git a/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst b/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst
index a0bbbe5c0..e7d513048 100644
--- a/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst
+++ b/docs/guides/onap-user/design/control-loop-design-steps/cl_design_instructions.rst
@@ -39,9 +39,11 @@ https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2-cl
- Click on the VF, as in the picture below the ‘vsp_pg 0’ is selected.
- Click on ‘DEPLOYMENT ARTIFACTS’ and then click on “Add Artifact”.
+
|image3|
- Fill the details and in the type select DCAE_INVENTORY_BLUEPRINT, then click on Done as in the picture shown below.
+
|image4|
5. After uploading the DCAE artifact to the SDC Service, attach the policy model to the Service. From the left drop down, select TCA policy under Policies, and click on the Add policy.
diff --git a/docs/guides/onap-user/vfw-design-tutorial/index.rst b/docs/guides/onap-user/vfw-design-tutorial/index.rst
index 77bfaefce..171d295d2 100644
--- a/docs/guides/onap-user/vfw-design-tutorial/index.rst
+++ b/docs/guides/onap-user/vfw-design-tutorial/index.rst
@@ -96,8 +96,12 @@ Let us start by creating the VLM
2. Create Vendor Software Product (VSP)
-Prerequisite: Download VNF Heat package from gerrit (git clone "https://gerrit.onap.org/r/demo") and copy
-the required HEAT package & use it while upload the package
+Prerequisite: Download VNF Heat package from gerrit
+
+.. code: bash
+ git clone "https://gerrit.onap.org/r/demo"
+
+and copy the required HEAT package & use it while upload the package
A. Go to SDC Home → ONBOARD → WORKSPACE → CREATE NEW VSP (complete all the fields, click on Network Package
checkbox then click create)
@@ -230,64 +234,45 @@ It will take you to the setup page
|image16|
-.. |image8| image:: media/image8.png
-.. |image21| image:: media/image21.png
-.. |image35| image:: media/image35.png
-.. |image34| image:: media/image34.png
-.. |image15| image:: media/image15.png
-.. |image38| image:: media/image38.png
+.. |image1| image:: media/image1.png
+.. |image2| image:: media/image2.png
+.. |image3| image:: media/image3.png
.. |image5| image:: media/image5.png
-.. |image40| image:: media/image40.png
-.. |image27| image:: media/image27.png
-.. |image32| image:: media/image32.png
-.. |image9| image:: media/image9.png
+.. |image6| image:: media/image6.png
.. |image7| image:: media/image7.png
-.. |image22| image:: media/image22.png
+.. |image8| image:: media/image8.png
+.. |image9| image:: media/image9.png
+.. |image10| image:: media/image10.png
+.. |image11| image:: media/image11.png
+.. |image12| image:: media/image12.png
+.. |image13| image:: media/image13.png
+.. |image14| image:: media/image14.png
+.. |image15| image:: media/image15.png
+.. |image16| image:: media/image16.png
+.. |image17| image:: media/image17.png
+.. |image18| image:: media/image18.png
+.. |image19| image:: media/image19.png
.. |image20| image:: media/image20.png
+.. |image21| image:: media/image21.png
+.. |image22| image:: media/image22.png
+.. |image23| image:: media/image23.png
.. |image24| image:: media/image24.png
-.. |image37| image:: media/image37.png
.. |image25| image:: media/image25.png
-.. |image17| image:: media/image17.png
-.. |image3| image:: media/image3.png
-.. |image13| image:: media/image13.png
-.. |image39| image:: media/image39.png
-.. |image43| image:: media/image43.png
+.. |image26| image:: media/image26.png
+.. |image27| image:: media/image27.png
+.. |image28| image:: media/image28.png
.. |image29| image:: media/image29.png
-.. |image10| image:: media/image10.png
-.. |image11| image:: media/image11.png
+.. |image30| image:: media/image30.png
.. |image31| image:: media/image31.png
-.. |image44| image:: media/image44.png
-.. |image19| image:: media/image19.png
-.. |image41| image:: media/image41.png
-.. |image14| image:: media/image14.png
-.. |image26| image:: media/image26.png
-.. |image1| image:: media/image1.png
+.. |image32| image:: media/image32.png
.. |image33| image:: media/image33.png
-.. |image2| image:: media/image2.png
-.. |image23| image:: media/image23.png
+.. |image34| image:: media/image34.png
+.. |image35| image:: media/image35.png
.. |image36| image:: media/image36.png
-.. |image6| image:: media/image6.png
-.. |image28| image:: media/image28.png
-.. |image31| image:: media/image31.png
-.. |image18| image:: media/image18.png
-.. |image30| image:: media/image30.png
-.. |image12| image:: media/image12.png
+.. |image37| image:: media/image37.png
+.. |image38| image:: media/image38.png
+.. |image39| image:: media/image39.png
+.. |image40| image:: media/image40.png
.. |image41| image:: media/image41.png
-.. |image16| image:: media/image16.png
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+.. |image43| image:: media/image43.png
+.. |image44| image:: media/image44.png
diff --git a/docs/release/index.rst b/docs/release/index.rst
index 10382093a..734d55990 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -23,14 +23,53 @@ Guilin Releases
===============
The following releases are available for Guilin:
+ - `Guilin Maintenance Release 7.0.1`_
- `Guilin Major Release 7.0.0`_
-Guilin Major Release 7.0.0
-==========================
+Guilin Maintenance Release 7.0.1
+================================
+
++--------------------------------------+--------------------------------------+
+| **Project** | Open Network Automation Platform |
+| | (ONAP) |
++--------------------------------------+--------------------------------------+
+| **Release name** | Guilin Maintenance Release |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release version** | 7.0.1 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | February 28th 2021 |
+| | |
++--------------------------------------+--------------------------------------+
-Release data
+New Features
============
+Guilin Maintenance Release 7.0.1 delivered a number of fixes and updates
+across the following projects:
+
+ - AAI - bug fixes
+ - OOM - bug fixes
+ - CCSDK - bug fixes
+ - DCAEGEN2 - bug fixes
+ - DMaaP - bug fixes
+ - DOC - restructure user guides section and added tutorials
+ - Integration - new docker for robot framework
+ - Music - certificate update
+ - MSB - bug fixes
+ - OOM - docker improvement
+ - SDNC - bug fixes
+ - SO - bug fixes
+ - VID - certificate update
+
+Details on the specific Jira tickets addressed by each project can be found in
+the component specific Release Notes: :ref:`release notes<doc-releaserepos>`
+
+
+Guilin Major Release 7.0.0
+==========================
+
+--------------------------------------+--------------------------------------+
| **Project** | Open Network Automation Platform |
| | (ONAP) |
diff --git a/docs/validwords.txt b/docs/spelling_wordlist.txt
index c860d4aa0..5140ec258 100644
--- a/docs/validwords.txt
+++ b/docs/spelling_wordlist.txt
@@ -1,5 +1,6 @@
AAF
AAI
+ACL
adaptor
Adaptor
adaptors
@@ -59,6 +60,7 @@ Fcaps
Financials
geocoder
Gerrit
+Git
Github
graphSON
guestOS
@@ -141,6 +143,7 @@ Junit
JUnit
Junits
JUnits
+Karaf
keypair
Keypair
keypairs
@@ -155,6 +158,7 @@ keytool
keyValue
Kibana
Kibibytes
+kubectl
Kubernetes
LF
lifecycle
@@ -173,6 +177,7 @@ macAddress
MacAddress
macOS
Malware
+MariaDB
metadata
Metadata
microservice
@@ -217,14 +222,18 @@ onboarding
Onboarding
online
OOF
+oom
OOM
OpenDaylight
+OpenFlow
openo
OpenO
Opensource
Openstack
OpenStack
OSS
+ovs
+ovsdb
Pandoc
partitionKey
Partitionkey
@@ -272,6 +281,7 @@ refactored
Refactored
registrator
Registrator
+releng
repo
Repo
repos
diff --git a/docs/tox.ini b/docs/tox.ini
deleted file mode 100644
index 9d8bf531a..000000000
--- a/docs/tox.ini
+++ /dev/null
@@ -1,44 +0,0 @@
-[tox]
-minversion = 1.6
-envlist = docs,
-# docs-linkcheck,
-
-skipsdist = true
-
-[testenv:docs]
-basepython = python3
-deps = -r{toxinidir}/../etc/requirements.txt
-commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-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 ./ {toxinidir}/_build/html
- echo "Generated docs available in {toxinidir}/_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 ./ {toxinidir}/_build/spellcheck
diff --git a/etc/requirements.txt b/etc/requirements.txt
index c743bce21..9f5b2aa35 100644
--- a/etc/requirements.txt
+++ b/etc/requirements.txt
@@ -1,15 +1,8 @@
-tox
-Sphinx
-doc8
-docutils
-setuptools
-six
-sphinx_rtd_theme>=0.4.3
+sphinx_rtd_theme
sphinxcontrib-blockdiag
sphinxcontrib-needs<0.6.0
sphinxcontrib-nwdiag
sphinxcontrib-seqdiag
sphinxcontrib-swaggerdoc
sphinxcontrib-plantuml
-sphinx_bootstrap_theme
lfdocs-conf
diff --git a/tox.ini b/tox.ini
index d4352d303..5807a8180 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,15 +1,13 @@
[tox]
minversion = 1.6
-envlist = docs,
-# docs-linkcheck,
-
+envlist = docs,docs-linkcheck
skipsdist = true
[testenv:docs]
basepython = python3
deps = -r{toxinidir}/etc/requirements.txt
commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
+ sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
whitelist_externals =
echo
@@ -30,15 +28,22 @@ whitelist_externals =
[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
+commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
[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
+commands =
+ sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
+
+[testenv:autopep8]
+deps = autopep8
+commands =
+ autopep8 --max-line-length 120 --in-place docs/conf.py
+
+[testenv:pylint]
+deps = pylint
+commands =
+ pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py