Merge pull request #260 from blink1073/pytest-warnings

.github/workflows/tests.yml

@@ -27,13 +27,9 @@ jobs:
             OS: "macos-latest"
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.PYTHON_VERSION }}
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install test dependencies
         run: |
-          pip install --upgrade pip setuptools wheel
           pip install .[test]
           pip install codecov pytest-cov
       - name: Install nbformat
@@ -43,8 +39,21 @@ jobs:
       - name: List dependencies
         run: pip list
       - name: Run tests
-        run: pytest -v --cov=nbformat --cov-report term-missing:skip-covered --no-cov-on-fail
+        run: python -m pytest -v --cov=nbformat --cov-report term-missing:skip-covered --no-cov-on-fail
       - name: Check manfest
         run: check-manifest -v
       - name: Coverage
         run: codecov
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Test docs
+        run: |
+          pip install .
+          cd docs
+          pip install -r requirements.txt
+          make html SPHINXOPTS="-W"
+          make linkcheck

docs/changelog.rst

@@ -102,7 +102,7 @@ In Development
 - Documented the editable metadata flag
 - Update description for collapsed field
 - Documented notebook format versions 4.0-4.3 with accurate json schema specification files
-- Clarified info about :ref:`name`'s meaning for cells
+- Clarified info about name's meaning for cells
 - Added a default execution_count of None for new_output_cell('execute_result')
 - Added support for handling nbjson kwargs
 - Wheels now correctly have a LICENSE file

docs/markup.rst

@@ -21,7 +21,7 @@ the following markdown flavors:
 *  `CommonMark <http://spec.commonmark.org/0.29/>`_.
 * `GitHub Flavored Markdown <https://github.github.com/gfm/>`_
 
-See the `Marked.js specification page <https://marked.js.org/#/README.md#specifications>`_
+See the `Marked.js specification page <https://marked.js.org>`_
 for more information.
 
 .. note::
@@ -62,5 +62,5 @@ This is currently the MathJax configuration that is used:
         },
     }
 
-See the `MathJax script for the classic Notebook UI <https://github.com/jupyter/notebook/blob/master/notebook/static/notebook/js/mathjaxutils.js>`_
+See the `MathJax script for the classic Notebook UI <https://github.com/jupyter/notebook/blob/6.4.x/notebook/static/notebook/js/mathjaxutils.js>`_
 for one example.

docs/requirements.txt

@@ -1,3 +1,4 @@
 jsonschema
--e git+https://github.com/jupyter/jupyter_core.git#egg=jupyter_core
-traitlets
+jupyter_core
+sphinx
+sphinxcontrib_github_alt

pyproject.toml

@@ -0,0 +1,13 @@
+[build-system]
+requires = ["setuptools>=60.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+addopts = "-raXs --durations 10 --color=yes --doctest-modules"
+testpaths = [
+    "tests/",
+]
+filterwarnings = [
+    "error",
+    "ignore:Using or importing the ABCs from 'collections':DeprecationWarning:jsonschema"
+]