Skip to content

1.0.0
Compare
Choose a tag to compare
@nomicode nomicode released this 03 Mar 21:08
· 69 commits to main since this release
1.0.0
270325b

Breaking Changes

IMPORTANT: You must update your Sphinx project's Makefile to pick up these changes. See docs/Makefile for details.

  • The demo Makefile now passes the correct target (html or linkcheck) through to sphinx-build (fixes #30).

  • The demo Makefile file now displays a warning message if you are using an out-of-date version of Crate Docs. If you see this message in the future, you will know there is an upgrade available for the build system.

  • We have silenced Make rules (too noisy and not helpful) and added informational messages to let you know what's going on.

  • We replaced some ANSI colors with ANSI bold to improve the readability of Make output for some consoles.

  • We added comments to the demo Makefile to document how the build system works.

Functionality

  • A new telemetry target now generates a Vale report and full git log CSV files for each RST file, including the commit subject.

    We may add a telemetry aggregation app to the Crate Docs project for QA use in the future. Ideally, this app would give you a reporting overview for all Sphinx projects.

    See #63 for more information and status updates.

  • Bump Vale from version 1.x to the most recent 2.x release.

  • Make no longer runs Vale when make devis run. Running Vale before every sphinx-autobuild was adding a significant delay to the editing workflow. This issue was exacerbated by the fact that Vale was run once for individual RST file.

    Now, Make runs Vale when make check is run. Additionally, Vale is run once for all files which improves speed.

    Because Vale is no longer necessary to run make dev or make html, there is no need to mock the Vale binary if Vale cannot be installed. Accordingly, Make will now error out when make check or make telemetry are run and Vale cannot be installed because Vale is essential for both of these targets.

  • Previously, Python 3.7 was required. Now, any version of Python >= 3.7 is allowed.

  • We are transitioning to Sphinx 3. Accordingly, we have relaxed the Sphinx 1.7.4 requirement to allow any version of Sphinx < 4.

Fixes

  • Disable proselint.Annotations so that using **NOTE** in standalone RST files does not raise an error.

  • The .venv directory (a Python virtual environment) is now created under .crate-docs. This change prevents many developer search tools from crossing that boundary and producing unwanted results.

Assets 2
Loading