Skip to content

Commit 5431f7c

Browse files
Add comments on Doc8 Style Guides
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 7051bd0 commit 5431f7c

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

docs/scripts/doc8_style_check.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22
# halt script on error
33
set -e
44
# Check for Style Code Violations
5+
# (Here D000 is ignored to bypass the include statement errors as the files we are including are
6+
# not in the same source folder as the include statement.)
7+
# [ToDo 1. Expand Scan to All Docs (source/) 2. Fix this D000 workaround if possible]
8+
# Doc Contribution Guide is at scancode-toolkit/contribute/contrib_doc.rst
59
doc8 --max-line-length 100 source/scancode-toolkit --ignore D000 --quiet

docs/source/doc_maintenance.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,9 @@ examples::
101101

102102
The AboutCode webhook with ReadTheDocs should rebuild the documentation. You can review your
103103
results online.
104+
105+
Documentation Style Guides
106+
--------------------------
107+
108+
The ``scancode-toolkit`` documentation is compliant to our doc style standards, enforced using
109+
``doc8``. For more details refer :ref:`contrib_doc_dev`.

0 commit comments

Comments
 (0)