Skip to content

Commit 816ad5e

Browse files
Hritik14Hritik14
committed
Enable linkcheck and nitpicky
None should be lost while finding a way Docs should link to what they say. Signed-off-by: Hritik Vijay <[email protected]>
1 parent fe574fc commit 816ad5e

File tree

5 files changed

+30
-18
lines changed

5 files changed

+30
-18
lines changed

‎SOURCES.rst‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,41 @@
33
+================+======================================================================================================+====================================================+
44
|rust | https://github.com/RustSec/advisory-db |rust crates |
55
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
6-
|alpine | https://secdb.alpinelinux.org/ |alpine packages |
6+
|alpine | https://secdb.alpinelinux.org/ |alpine packages |
77
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
8-
|archlinux | https://security.archlinux.org/json |arch packages |
8+
|archlinux | https://security.archlinux.org/json |arch packages |
99
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
10-
|debian | https://security-tracker.debian.org/tracker/data/json |debian packages |
10+
|debian | https://security-tracker.debian.org/tracker/data/json |debian packages |
1111
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
12-
|npm | https://github.com/nodejs/security-wg.git |npm packages |
12+
|npm | https://github.com/nodejs/security-wg.git |npm packages |
1313
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
1414
|ruby | https://github.com/rubysec/ruby-advisory-db.git |ruby gems |
1515
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
16-
|ubuntu | https://people.canonical.com/~ubuntu-security/oval/ |ubuntu packages |
16+
|ubuntu | https://people.canonical.com/~ubuntu-security/oval/ |ubuntu packages |
1717
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
18-
|retiredotnet | https://github.com/RetireNet/Packages.git |.NET packages |
18+
|retiredotnet | https://github.com/RetireNet/Packages.git |.NET packages |
1919
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
20-
|suse_backports | http://ftp.suse.com/pub/projects/security/yaml/ |SUSE packages |
20+
|suse_backports | http://ftp.suse.com/pub/projects/security/yaml/ |SUSE packages |
2121
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
22-
|debian_oval | https://www.debian.org/security/oval/ |debian packages |
22+
|debian_oval | https://www.debian.org/security/oval/ |debian packages |
2323
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
24-
|redhat | https://access.redhat.com/hydra/rest/securitydata/cve.json |rpm packages |
24+
|redhat | https://access.redhat.com/hydra/rest/securitydata/cve.json |rpm packages |
2525
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
2626
|nvd | https://nvd.nist.gov/vuln/data-feeds#JSON_FEED |none |
2727
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
28-
|gentoo | https://anongit.gentoo.org/git/data/glsa.git |gentoo packages |
28+
|gentoo | https://anongit.gentoo.org/git/data/glsa.git |gentoo packages |
2929
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
3030
|openssl | https://www.openssl.org/news/vulnerabilities.xml |openssl |
3131
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
32-
|ubuntu_usn | https://usn.ubuntu.com/usn-db/database-all.json.bz2 |ubuntu packages |
32+
|ubuntu_usn | https://usn.ubuntu.com/usn-db/database-all.json.bz2 |ubuntu packages |
3333
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
34-
|github | https://api.github.com/graphql |maven, .NET, php-composer, pypi packages. ruby gems |
34+
|github | https://api.github.com/graphql |maven, .NET, php-composer, pypi packages. ruby gems |
3535
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
36-
|msr2019 | https://raw.githubusercontent.com/SAP/project-kb/master/MSR2019/dataset/vulas_db_msr2019_release.csv |maven packages |
36+
|msr2019 | https://raw.githubusercontent.com/SAP/project-kb/master/MSR2019/dataset/vulas_db_msr2019_release.csv |maven packages |
3737
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
38-
|apache_httpd | https://httpd.apache.org/security/vulnerabilities-httpd.xml |apache-httpd |
38+
|apache_httpd | https://httpd.apache.org/security/json |apache-httpd |
3939
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
40-
|kaybee | https://github.com/SAP/project-kb.git |maven packages |
40+
|kaybee | https://github.com/SAP/project-kb.git |maven packages |
4141
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+
4242
|nginx | http://nginx.org/en/security_advisories.html |nginx |
4343
+----------------+------------------------------------------------------------------------------------------------------+----------------------------------------------------+

‎docs/source/command-line-interface.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Other variations:
6363

6464

6565
``$ ./manage.py purl2cpe --destination <directory``
66-
------------------------------------------
66+
---------------------------------------------------
6767

6868
Dump a mapping of CPEs to PURLs grouped by vulnerability in the ``destination``
6969
directory.

‎docs/source/conf.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,18 @@
2424

2525
# -- General configuration ---------------------------------------------------
2626

27+
# Ensure there are no invalid URLs
28+
# Use -b linkcheck to check integrity of all external links
29+
nitpicky = True
30+
linkcheck_anchors = False # See: https://github.com/sphinx-doc/sphinx/issues/9016
31+
linkcheck_ignore = [
32+
r"http://localhost:\d+/",
33+
r"http://127.0.0.1:\d+/",
34+
"https://api.github.com/graphql", # Requires auth
35+
"https://anongit.gentoo.org/git/data/glsa.git", # Git only link
36+
"https://www.softwaretestinghelp.com/how-to-write-good-bug-report/", # Cloudflare protection
37+
]
38+
2739
# Add any Sphinx extension module names here, as strings. They can be
2840
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2941
# ones.

‎docs/source/contributing.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ resources to help you get started.
1111

1212
.. note::
1313
By contributing to the VulnerableCode project, you agree to the Developer
14-
`Certificate of Origin <http://developercertificate.org/>`_.
14+
`Certificate of Origin <https://developercertificate.org/>`_.
1515

1616

1717
Do Your Homework

‎docs/source/tutorial_add_new_importer.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ The SPDX license identifiers can be found at https://spdx.org/licenses/.
9797

9898
.. note::
9999
An SPDX license identifier by itself is a valid licence expression. In case you need more complex
100-
expressions, see https://spdx.github.io/spdx-spec/SPDX-license-expressions/
100+
expressions, see https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/
101101

102102
Implement the ``advisory_data`` Method
103103
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)