Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Nov 13, 2023
1 parent 4f66ac4 commit fab5238
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
13 changes: 8 additions & 5 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,23 @@ License
-----

:Released: 13.11.2023
:Full Changelog: `https://github.com/useblocks/sphinx-needs/compare/1.3.0...v2.0.0`_
:Full Changelog: `1.3.0...v2.0.0 <https://github.com/useblocks/sphinx-needs/compare/1.3.0...v2.0.0>`__

This release is focussed on improving the internal code-base and its build time performance, as well as improved build warnings and other functionality improvements / fixes.

Changed
.......

* Update to Sphinx 7 and drop Python 3.7 (`#1056 <https://github.com/useblocks/sphinx-needs/pull/1056>`_)
* Make matplotlib dependency optional (`#1061 <https://github.com/useblocks/sphinx-needs/pull/1061>`_)
* Change ``NeedsBuilder`` format to ``needs`` (`#978 <https://github.com/useblocks/sphinx-needs/pull/978>`_)
* Add Sphinx 7 support and drop Python 3.7 (`#1056 <https://github.com/useblocks/sphinx-needs/pull/1056>`_).
Sphinx 5, 6, 7 and Python 3.8 to 3.11 are now fully supported and tested.
* The ``matplotlib`` dependency (for ``needbar`` and ``needpie`` plots) is now optional, and should be installed with ``sphinx-needs[plotting]``, see :ref:`installation` (`#1061 <https://github.com/useblocks/sphinx-needs/pull/1061>`_)
* The ``NeedsBuilder`` format name is changed to ``needs`` (`#978 <https://github.com/useblocks/sphinx-needs/pull/978>`_)

New
...

* Added Builder :ref:`needs_id_builder` and config option :ref:`needs_build_json_per_id` in ``conf.py`` (`#960 <https://github.com/useblocks/sphinx-needs/pull/960>`_)
* Added `needs_reproducible_json` config option (`#1065 <https://github.com/useblocks/sphinx-needs/pull/1065>`_)
* Added ``needs_reproducible_json`` config option for the needs builder, see :ref:`needs_build_json` (`#1065 <https://github.com/useblocks/sphinx-needs/pull/1065>`_)
* Added error messages for constraint failures (`#1036 <https://github.com/useblocks/sphinx-needs/pull/1036>`_)

Improved
Expand Down
2 changes: 2 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _installation:

Installation
============

Expand Down
11 changes: 9 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,15 @@ def pre_commit(session):
session.run("pre-commit", "run", "--all-files", *session.posargs, external=True)


@session(python="3.10")
@session(python="3.11")
def linkcheck(session):
session.install(".[docs]")
with session.chdir("docs"):
session.run("sphinx-build", "-b", "linkcheck", ".", "_build", *session.posargs, external=True)
session.run("sphinx-build", "-b", "linkcheck", ".", "_build/linkcheck", *session.posargs, external=True)


@session(python="3.11")
def docs(session):
session.install(".[docs]")
with session.chdir("docs"):
session.run("sphinx-build", ".", "_build", *session.posargs, external=True)

0 comments on commit fab5238

Please sign in to comment.