Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 4.15 KB

CHANGELOG.md

File metadata and controls

105 lines (81 loc) · 4.15 KB

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.

Unreleased

Added

  • Add @rst/@endrst aliases to Doxygen config. This makes it easier to use RST (e.g. for references) in Doxygen blocks.

1.4.0 -- 2024-07-01

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.

1.3.1 - 2023-03-20

Changed

  • Python API: List content of actual module before submodules

1.3.0 - 2023-03-14

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:.

1.2.0 - 2022-11-24

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).

1.1.1 - 2022-11-11

Fixed

  • Fixed issue with configuration validation that rejected valid intersphinx mapping configuration.

1.1.0 - 2022-11-04

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.

1.0.0 - 2022-10-21

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

0.1.0 - 2022-09-08

Extracted the documentation build code from mpi_cmake_modules with only some minor changes.