Merge pull request #1969 from apiaryio/abtris/fix-docs

fix docs

.github/dependabot.yml

@@ -0,0 +1,63 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10
+  labels:
+  - dependencies
+  ignore:
+  - dependency-name: nock
+    versions:
+    - "> 10.0.6"
+  - dependency-name: typescript
+    versions:
+    - ">= 4.1.a, < 4.2"
+  - dependency-name: winston
+    versions:
+    - "> 2.4.0"
+  - dependency-name: eslint-config-prettier
+    versions:
+    - 7.2.0
+    - 8.0.0
+    - 8.1.0
+    - 8.2.0
+  - dependency-name: eslint
+    versions:
+    - 7.18.0
+    - 7.19.0
+    - 7.20.0
+    - 7.21.0
+    - 7.22.0
+    - 7.23.0
+    - 7.24.0
+  - dependency-name: "@types/chai"
+    versions:
+    - 4.2.14
+    - 4.2.15
+    - 4.2.16
+  commit-message:
+    prefix: fix
+    prefix-development: chore
+    include: scope
+- package-ecosystem: pip
+  directory: "/docs"
+  schedule:
+    interval: weekly
+    time: "13:00"
+  open-pull-requests-limit: 10
+  labels:
+  - dependencies
+  ignore:
+  - dependency-name: sphinx
+    versions:
+    - 3.5.0
+    - 3.5.1
+    - 3.5.2
+    - 3.5.3
+  commit-message:
+    prefix: chore
+    prefix-development: chore
+    include: scope

docs/internals.rst

@@ -129,7 +129,7 @@ C++ dependencies
 
 Dredd uses `Drafter <https://github.com/apiaryio/drafter>`__ for parsing `API Blueprint`_ documents. Drafter is written in C++ and needs to be compiled during installation. Because that can cause a lot of problems in some environments, there’s also pure JavaScript version of the parser, `drafter.js <https://github.com/apiaryio/drafter.js>`__. Drafter.js is fully equivalent, but it can have slower performance. Therefore there’s `drafter-npm <https://github.com/apiaryio/drafter-npm/>`__ package, which tries to compile the C++ version of the parser and in case of failure it falls back to the JavaScript equivalent. Dredd depends on the `drafter-npm <https://github.com/apiaryio/drafter-npm/>`__ package.
 
-That still proved problematic for Dredd though. The current solution is to provide an `npm-shrinkwrap.json <https://docs.npmjs.com/files/shrinkwrap.json>`__ file with the `Dredd Transactions`_ library, which completely excludes `protagonist <https://github.com/apiaryio/protagonist>`__, i.e. the compiled C++ binding. Unlike ``package-lock.json``, the file can be distributed inside an npm package. The exclusion is performed by a ``postshrinkwrap`` npm script. This didn't work well with Dredd's ``package-lock.json``, so currently Dredd's dependency tree is not locked for local or CI installations.
+That still proved problematic for Dredd though. The current solution is to provide an `npm-shrinkwrap.json <https://docs.npmjs.com/cli/v6/configuring-npm/shrinkwrap-json>`__ file with the `Dredd Transactions`_ library, which completely excludes `protagonist <https://github.com/apiaryio/protagonist>`__, i.e. the compiled C++ binding. Unlike ``package-lock.json``, the file can be distributed inside an npm package. The exclusion is performed by a ``postshrinkwrap`` npm script. This didn't work well with Dredd's ``package-lock.json``, so currently Dredd's dependency tree is not locked for local or CI installations.
 
 
 Supported Node.js versions
@@ -234,7 +234,7 @@ The documentation is built by `Sphinx <http://www.sphinx-doc.org/>`__. To render
 
    .. note::
 
-      We are not using `pipenv <https://pipenv.readthedocs.io/>`__ as it is not yet properly supported by ReadTheDocs.
+      We are not using `pipenv <https://github.com/pypa/pipenv>`__ as it is not yet properly supported by ReadTheDocs.
 
 Now you can use following commands:
 

docs/requirements.txt

@@ -3,12 +3,12 @@
 
 
 # dependencies
-sphinx==3.4.3
-jinja2==2.11.3
+sphinx==3.5.4
+jinja2==3.0.1
 git+https://github.com/jhermann/pygments-markdown-lexer.git@e651a9a3f664285b01451eb39232b1ad9af65956#egg=pygments-markdown-lexer
 pygments-apiblueprint==0.2.0
-sphinx-tabs==2.0.1
+sphinx-tabs==3.1.0
 
 # dev dependencies
-sphinx-autobuild==2020.9.1
-sphinx-rtd-theme==0.5.1
+sphinx-autobuild==2021.3.14
+sphinx-rtd-theme==0.5.2