Skip to content

Commit 5d56307

Browse files
Add RTD requirements file and test scripts
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent d16959a commit 5d56307

3 files changed

Lines changed: 13 additions & 0 deletions

File tree

docs/requirements-doc.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
doc8==0.8.1
2+
Sphinx==3.3.1
3+
sphinx-rtd-theme==0.5.0

docs/scripts/doc8_style_check.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/bash
2+
# halt script on error
3+
set -e
4+
# Check for Style Code Violations
5+
doc8 --max-line-length 100 source --ignore D000 --quiet
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/bash
2+
# halt script on error
3+
set -e
4+
# Build locally, and then check links
5+
sphinx-build -E -W -b linkcheck source build

0 commit comments

Comments
 (0)