Skip to content

Disable autotosectionlabel plugin in documentation#942

Merged
arogge merged 3 commits intobareos:masterfrom
arogge:dev/arogge/master/disable-autosectionlabel
Sep 30, 2021
Merged

Disable autotosectionlabel plugin in documentation#942
arogge merged 3 commits intobareos:masterfrom
arogge:dev/arogge/master/disable-autosectionlabel

Conversation

@arogge
Copy link
Member

@arogge arogge commented Sep 28, 2021

This PR disables the autosectionlabel plugin in Sphinx as it produces issues with some of our autogenerated headings (especially in release notes). The headings that has autogenerated labels and were referenced by them now have matching labels added manually.

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
  • bareos-check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing

This patch adds the labels that were previously provided by
autosectionlabel.
@arogge arogge force-pushed the dev/arogge/master/disable-autosectionlabel branch from ec88699 to 6704749 Compare September 30, 2021 13:21
@arogge arogge merged commit a3c364f into bareos:master Sep 30, 2021
@arogge arogge deleted the dev/arogge/master/disable-autosectionlabel branch September 30, 2021 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants