Skip to content

Conversation

@andthum
Copy link
Owner

@andthum andthum commented Feb 13, 2023

Update Documentation

Type of Change

  • Bug fix.
  • New feature.
  • Code refactoring.
  • Dependency update.
  • Documentation update.
  • Maintenance.
  • Other: Description.
  • Non-breaking (backward-compatible) change.
  • Breaking (non-backward-compatible) change.
  • I followed the guidelines in the Developer's Guide.
  • [~] New/changed code is properly tested.
  • [~] New/changed code is properly documented.
  • The CI workflow is passing.

Add `-type d` to
`AUTOSUMDIR = $(shell find $(SOURCEDIR) -type d -name "$(AUTOSUMDIR_PATTERN)")`
to make the find command more robust.
Update
* sphinx from `>=3.0, <7.0` `>=5.0, <7.0`.
* sphinx-rtd-theme from `<2.0` to `>=1.0, <2.0`.
* tomlkit from `< 1.0` to `>=0.1, < 1.0`.
Increase minimum required sphinx version from `3.0` to `5.0`.

Update the year in the copyright notice from "2021, 2022" to
"2021-2023".

Make the import of python modules more robust.
Add instructions how to remove build artifacts.
Add instructions how to remove build artifacts.
Add a note that the markdownlint pre-commit hook requires markdownlint
to be installed.
Update instructions about how to publish a new release.
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 13, 2023
@andthum andthum merged commit 312b663 into main Feb 13, 2023
@andthum andthum deleted the docs/update branch February 13, 2023 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants