Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Released

0.5.0 - 2022-12-17

Added

  • Example for ReStructuredText evaluation directive to show a warning and a notes highlighted text

Changed

  • Removed outdated command to convert Markdown files to ReStructuredText files

Fixed

  • Call to generate sphinx documentation in USAGE

0.4.0 - 2022-12-06

Added

  • Usage guide for building docs locally in root README

  • changelog_link.rst added to docs to include this changelog from its real location without further relocation before building the docs

Changed

  • Relocate files of docs/source into docs directly

  • Replace ReStructuredText references in Markdown files of docs

  • docutils >=0.14,<0.18 is required to build the docs

  • Sphinx extensions sorted aphabetically in config.py

Removed

  • Documentation build process is no longer depending in m2rr package

  • Unused batch file and Makefile

0.3.0 - 2022-10-29

Added

  • Add link to created documentation to root README

Fixed

  • Subtitle of root README does not reference MicroPython

0.2.0 - 2022-10-29

Added

  • Docs badge to root README, see #2

Changed

  • Converted root README from Markdown to ReStructuredText

0.1.0 - 2022-10-29

Added

  • This changelog file

  • .gitignore file

  • Docs requirements.txt file to setup tools for documentation generation

  • .readthedocs.yaml file to define custom actions after the default installation and before the actual docs build process

  • Dummy python package files

  • Script to convert Markdown to ReStructuredText files for Sphinx