v1.4.0

Changes since 1.3.1

Added

• Options --skip-cpp, --skip-python and --skip-cmake to disable
  auto-generated API documentation for the corresponding language.
• Custom confval directive and role for documenting configuration
  parameters.

v1.3.0

Changes since 1.2.0

Added

• Config parameter html.logo to specify an image that is shown in the top of
  the navigation bar.
• Create a symlink called PKG in the build directory that points to the project source
  directory. This allows, for example, to include example scripts from the source
  directory into RST files, using a path like /PKG/scripts/example.py.

Changed

• Private members of C++ classes are not shown anymore. This affects the
  auto-generated API documentation as well as usages of .. doxygenclass:: in
  the general documentation. In the latter they can be added back if desired by
  specifying :private-members:.

v1.2.0

Changes since 1.1.1

Added

• If the package root contains a file doc_mainpage.{rst,md}, it is used instead of the
  README to fill the main page. This is useful if the content of the README is not
  suitable for the documentation main page.
• Add config parameter mainpage.title to set a custom title.
• Add config parameter mainpage.auto_general_docs to disable automatic creation of a
  toctree for files in doc/.
• Mark external links with an icon (sphinx-rtd-theme setting style_external_links).

v1.1.1

Version 1.1.1

Changes since 1.1.0:

Fixed:
- Fixed issue with configuration validation that rejected valid
  intersphinx mapping configuration.

v1.1.0

Changes since v1.0.0

Changed

• Syntax for the package directory variable in the
  doxygen.excluded_patterns config is now {{PACKAGE_DIR}}. The old
  ${PACKAGE_DIR} is still supported for now but deprecated (see
  below).

Deprecated

• Using ${PACKAGE_DIR} in the doxygen.excluded_patterns config is
  deprecated, use {{PACKAGE_DIR}} instead.

v1.0.0

Changes since v0.1.0

Added

• Support for plain text READMEs ("README" or "README.TXT").
• Try to auto-detect package version if not explicitly specified.
• Install executable bcat.
• Short arguments -p/-o for --package-dir/--output-dir.
• Provide additional configuration via breathing_cat.toml
• Add DOXYGEN_EXCLUDE_PATTERNS via config file.
• Add intersphinx mappings via config file.

Changed

• If multiple READMEs are found, do not prefer a specific type but simply use the first
  one found.
• Renamed --project-version to --package-version.
• Use MyST parser instead of recommonmark and m2r for including Markdown files.

Fixed

• Workaround for an incompatibility issue between the RTD theme and autodoc, which
  caused class properties to be floating (see readthedocs/sphinx_rtd_theme#1247)