Merge remote-tracking branch 'upstream/master'

* upstream/master: (35 commits) rename readme section to add FAQ whitespace add known limitations section; rstcheck#97 whitespace cli args take precedence over config files; fixes rstcheck#96 state config file hierarchy; rstcheck#96 update changelog change back to code-block b/c of sphinx context guard directive remove actions remove cli option for sphinx defaults remove unused noqa allow code blocks to be ignored; fixes rstcheck#79 fix types prewrap test resuls in dict for better introspection overwrite code-block and sourcecode directives without sphinx again remove code and code-block from sphinx ignore list load directives and roles from sphinx's docutils update extended default sphinx directives and roles drop sphinx default values add code-block to sphinx ignore roles ...
weibullguy · Apr 18, 2022 · d4c440c · d4c440c
2 parents 583d5c3 + e989abf
commit d4c440c
Show file tree

Hide file tree

Showing 18 changed files with 297 additions and 246 deletions.
diff --git a/README.rst b/README.rst
@@ -165,6 +165,10 @@ local configuration file of the project (just replace ``-`` for ``_``).
 ``pyproject.toml`` in the directory or ancestor directories of the file it is
 checking.
 
+``.rstcheck.cfg`` takes precedence over ``setup.cfg``.
+
+Settings in the config file are overwritten by CLI options.
+
 For example, consider a project with the following directory structure
 
 .. code:: text
@@ -259,7 +263,7 @@ constraint is >=4.0 because of Sphinx's open upper constraints on jinja2 and mar
 which result in import errors if not pinned below version 3 and 2 respectively. This happend
 in Sphinx version 4.0.
 
-You can also add Sphinx by yourself but the installed Sphinx version must be at least 1.5.
+You can also add Sphinx by yourself but the installed Sphinx version must be at least 2.0.
 
 To check that Sphinx support is enabled
 
@@ -288,6 +292,7 @@ Just install ``rstcheck`` and make sure is on your path.
 .. _Syntastic: https://github.com/scrooloose/syntastic
 .. _ALE: https://github.com/w0rp/ale
 
+
 Use as a module
 ===============
 
@@ -378,13 +383,36 @@ To run all the tests you have three options
     $ tox
 
 
+Known limitations / FAQ
+=======================
+
+There are inherent limitations to what ``rstcheck`` can and cannot do. The reason for this is that
+``rstcheck`` itself does not parse the rst source but gives it to ``docutils`` and gets the errors
+back. Therefore rstcheck in the sense of rst source is more an error accumulation tool. The same
+goes for the source code in supported code blocks.
+
+
 History
 =======
 
 
 (next version)
 --------------
 
+- Fix inability to ignore ``code``, ``code-block`` and ``sourcecode`` directives (#79)
+- Fix ``code-block`` options recognition (#62)
+- Add section with ``Known limitations / FAQ`` to the README (#97)
+
+
+.. _beaking_changes_v6:
+
+BREAKING CHANGES
+~~~~~~~~~~~~~~~~
+
+- Drop support for sphinx < 2.0
+- Drop default values for directves and roles for sphinx (#65)
+- CLI options now take precedence over config file options (#96)
+
 
 5.0.0 (2022-04-17)
 ------------------
@@ -394,6 +422,7 @@ History
 - Add ``Mega-Linter`` section to README
 - Add ``BREAKING CHANGES`` sections to changelog
 
+
 .. _beaking_changes_v5:
 
 BREAKING CHANGES

diff --git a/examples/bad/bad_bash.rst b/examples/bad/bad_bash.rst
@@ -2,6 +2,6 @@
 Test
 ====
 
-.. code-block:: bash
+.. code:: bash
 
     {
diff --git a/examples/bad/bad_code.rst b/examples/bad/bad_code.rst
@@ -2,8 +2,6 @@
 Test
 ====
 
-``code`` rather than ``code-block``.
-
 .. code:: python
 
     print(
diff --git a/examples/bad/bad_cpp.rst b/examples/bad/bad_cpp.rst
@@ -2,7 +2,7 @@
 Test
 ====
 
-.. code-block:: cpp
+.. code:: cpp
 
     int main()
     {

diff --git a/examples/bad/bad_python.rst b/examples/bad/bad_python.rst
@@ -2,6 +2,6 @@
 Test
 ====
 
-.. code-block:: python
+.. code:: python
 
     print(
diff --git a/examples/bad/bad_rst_in_rst.rst b/examples/bad/bad_rst_in_rst.rst
@@ -2,7 +2,7 @@
 Test
 ====
 
-.. code-block:: rst
+.. code:: rst
 
     Testing
     ===
diff --git a/examples/good/good.rst b/examples/good/good.rst
@@ -2,14 +2,14 @@
 Test
 ====
 
-.. code-block:: bash
+.. code:: bash
 
     if [ "$x" == 'y' ]
     then
         exit 1
     fi
 
-.. code-block:: c
+.. code:: c
 
     float foo(int n)
     {
@@ -19,7 +19,7 @@ Test
         return x[0];
     }
 
-.. code-block:: cpp
+.. code:: cpp
 
     #include <iostream>
 
@@ -29,20 +29,20 @@ Test
         return x;
     }
 
-.. code-block:: python
+.. code:: python
 
     print(1)
 
 Run more tests for checking performance.
 
-.. code-block:: bash
+.. code:: bash
 
     if [ "$x" == 'y' ]
     then
         exit 1
     fi
 
-.. code-block:: c
+.. code:: c
 
     float foo(int n)
     {
@@ -52,7 +52,7 @@ Run more tests for checking performance.
         return x[0];
     }
 
-.. code-block:: cpp
+.. code:: cpp
 
     #include <iostream>
 
@@ -62,18 +62,18 @@ Run more tests for checking performance.
         return x;
     }
 
-.. code-block:: python
+.. code:: python
 
     print(1)
 
-.. code-block:: bash
+.. code:: bash
 
     if [ "$x" == 'y' ]
     then
         exit 1
     fi
 
-.. code-block:: c
+.. code:: c
 
     float foo(int n)
     {
@@ -83,7 +83,7 @@ Run more tests for checking performance.
         return x[0];
     }
 
-.. code-block:: cpp
+.. code:: cpp
 
     #include <iostream>
 
@@ -93,18 +93,18 @@ Run more tests for checking performance.
         return x;
     }
 
-.. code-block:: python
+.. code:: python
 
     print(1)
 
-.. code-block:: bash
+.. code:: bash
 
     if [ "$x" == 'y' ]
     then
         exit 1
     fi
 
-.. code-block:: c
+.. code:: c
 
     float foo(int n)
     {
@@ -114,7 +114,7 @@ Run more tests for checking performance.
         return x[0];
     }
 
-.. code-block:: cpp
+.. code:: cpp
 
     #include <iostream>
 
@@ -124,18 +124,18 @@ Run more tests for checking performance.
         return x;
     }
 
-.. code-block:: python
+.. code:: python
 
     print(1)
 
-.. code-block:: bash
+.. code:: bash
 
     if [ "$x" == 'y' ]
     then
         exit 1
     fi
 
-.. code-block:: c
+.. code:: c
 
     float foo(int n)
     {
@@ -145,7 +145,7 @@ Run more tests for checking performance.
         return x[0];
     }
 
-.. code-block:: cpp
+.. code:: cpp
 
     #include <iostream>
 
@@ -155,7 +155,7 @@ Run more tests for checking performance.
         return x;
     }
 
-.. code-block:: python
+.. code:: python
 
     # ¬∆˚ß∂ƒß∂ƒ˚¬∆
     print(1)
diff --git a/examples/good/good_cpp_with_local_include.rst b/examples/good/good_cpp_with_local_include.rst
@@ -2,7 +2,7 @@
 Test
 ====
 
-.. code-block:: cpp
+.. code:: cpp
 
     #include "foo.h"
 

diff --git a/examples/good/good_markdown.rst b/examples/good/good_markdown.rst
@@ -2,6 +2,6 @@
 Test
 ====
 
-.. code-block:: markdown
+.. code:: markdown
 
     [Markdown-style Link](https://www.example.com/)
diff --git a/examples/good/unicode.rst b/examples/good/unicode.rst
@@ -2,11 +2,11 @@
 Тест
 ====
 
-.. code-block:: python
+.. code:: python
 
    print("Привет!")
 
-.. code-block:: bash
+.. code:: bash
 
     $ echo 'Привет' >> pipe.txt
     $ echo 'файловая труба!' >> pipe.txt
diff --git a/examples/good/unknown.rst → examples/sphinx/good.rst b/examples/good/unknown.rst → examples/sphinx/good.rst
diff --git a/examples/with_configuration/bad.rst b/examples/with_configuration/bad.rst
@@ -3,7 +3,7 @@
 
 :some-custom-thing:`testing`
 
-.. code-block:: cpp
+.. code:: cpp
 
     int main()
     {

diff --git a/examples/with_configuration/good.rst b/examples/with_configuration/good.rst
@@ -3,7 +3,7 @@
 
 :some-custom-thing:`testing`
 
-.. code-block:: cpp
+.. code:: cpp
 
     int main()
     {

diff --git a/examples/without_configuration/good.rst b/examples/without_configuration/good.rst
@@ -3,7 +3,7 @@
 
 :some-custom-thing:`testing`
 
-.. code-block:: cpp
+.. code:: cpp
 
     int main()
     {