Simple API and SW Docs

Commit:

2ea7b1da58

Contents:

• 1.0 Requirements overview {#REQ001}
• 1.0 Design Elements {#SDD001}
• 1.0 Automated Tests {#TST001}
• Simple Python Project
• simple
• Changelog Generation
• Contents of the .pre-commit-config.yaml file
• Using Pre-Commit

Recent changes

• Merge pull request #16 from sarnold/misc-improvements by Steve Arnold at 2025-09-28 19:17:32

  improve docs
  

• chg: dev: add note about gh-pages branch, add Docs link to project urls by Stephen L Arnold at 2025-09-27 03:21:01

  * add note about rpmget as more fleshed out doorstop example
  
  Signed-off-by: Stephen L Arnold <sarnold@vctlabs.com>
  

• ci: bump VCTLabs/bandit-report-artifacts in the all-actions group (#15) by dependabot[bot] at 2025-09-25 20:23:45

  Bumps the all-actions group with 1 update: [VCTLabs/bandit-report-artifacts](https://github.com/vctlabs/bandit-report-artifacts).
  
  
  Updates `VCTLabs/bandit-report-artifacts` from 0.0.3 to 0.3.0
  - [Commits](https://github.com/vctlabs/bandit-report-artifacts/compare/b0679c4dff0c2ed69000132fabf6a9e1b7dcfd5c...edaffcb8ce8618e97d6838d7a0535331927e6d77)
  
  ---
  updated-dependencies:
  - dependency-name: VCTLabs/bandit-report-artifacts
    dependency-version: 0.3.0
    dependency-type: direct:production
    update-type: version-update:semver-minor
    dependency-group: all-actions
  ...
  
  Signed-off-by: dependabot[bot] <support@github.com>
  Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  

• ci: bump ad-m/github-push-action in the all-actions group (#14) by dependabot[bot] at 2025-09-12 20:17:53

  Bumps the all-actions group with 1 update: [ad-m/github-push-action](https://github.com/ad-m/github-push-action).
  
  
  Updates `ad-m/github-push-action` from 0.8.0 to 1.0.0
  - [Release notes](https://github.com/ad-m/github-push-action/releases)
  - [Commits](https://github.com/ad-m/github-push-action/compare/d91a481090679876dfc4178fef17f286781251df...77c5b412c50b723d2a4fbc6d71fb5723bcd439aa)
  
  ---
  updated-dependencies:
  - dependency-name: ad-m/github-push-action
    dependency-version: 1.0.0
    dependency-type: direct:production
    update-type: version-update:semver-major
    dependency-group: all-actions
  ...
  
  Signed-off-by: dependabot[bot] <support@github.com>
  Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  

• ci: bump softprops/action-gh-release in the all-actions group (#13) by dependabot[bot] at 2025-09-08 20:50:01

  Bumps the all-actions group with 1 update: [softprops/action-gh-release](https://github.com/softprops/action-gh-release).
  
  
  Updates `softprops/action-gh-release` from 2.3.2 to 2.3.3
  - [Release notes](https://github.com/softprops/action-gh-release/releases)
  - [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
  - [Commits](https://github.com/softprops/action-gh-release/compare/72f2c25fcb47643c292f7107632f7a47c1df5cd8...6cbd405e2c4e67a21c47fa9e383d020e4e28b836)
  
  ---
  updated-dependencies:
  - dependency-name: softprops/action-gh-release
    dependency-version: 2.3.3
    dependency-type: direct:production
    update-type: version-update:semver-patch
    dependency-group: all-actions
  ...
  
  Signed-off-by: dependabot[bot] <support@github.com>
  Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  

Indices and tables

• Index

• Module Index