Update 'doc/source/index.rst'

api-ref/source/conf.py

@@ -18,7 +18,7 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]
 
 otcdocs_auto_name = False

doc/requirements.txt

@@ -2,3 +2,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD
 otcdocstheme # Apache-2.0
 # releasenotes
 reno>=3.1.0 # Apache-2.0
+
+otc-sphinx-directives>=0.1.0
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

doc/source/index.rst

@@ -0,0 +1,13 @@
+Dedicated Web Application Firewall
+==================================
+
+Web Application Firewall (WAF) keeps web services stable and secure. It examines all HTTP and HTTPS requests to detect and block the following attacks: Structured Query Language (SQL) injection, cross-site scripting (XSS), webshells, command and code injections, file inclusion, sensitive file access, third-party vulnerability exploits, Challenge Collapsar (CC) attacks, malicious crawlers, and cross-site request forgery (CSRF).
+
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. service_card::
+      :service_type: wafd
+      :umn: This document helps you know about the Web Application Firewall (Dedicated) and guide you on how to use the service.
+      :api-ref: This document describes application programming interfaces (APIs) of the Web Application Firewall (Dedicated) and provides API parameter description and example values.

tox.ini

@@ -29,7 +29,11 @@ allowlist_externals =
   mkdir
   cp
   sh
+  rm
+  sphinx-build
 commands =
+  rm -rf doc/build/html doc/build/doctrees
+  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
   {[testenv:umn]commands}
@@ -138,3 +142,8 @@ commands =
   mkdir -p doc/build/pdf
   cp umn/build/pdf/wafd-umn.pdf doc/build/pdf/
 
+
+
+[doc8]
+ignore = D001
+extensions = .rst, .yaml

umn/source/conf.py

@@ -18,7 +18,7 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]
 
 otcdocs_auto_name = False