code-annotations

Extensible tools for parsing annotations in codebases

Contents:

General

• README
  • Overview
  • Documentation
  • License
  • How To Contribute
  • Reporting Security Issues
  • Getting Help
• Getting Started
  • Install the requirements
  • Run the tests
  • Create a configuration file
  • Create some annotations
  • Run an annotation search
  • Add more structure to your annotations
• Writing Annotations
  • Annotation Groups
• Static Search Tool
  • Overview
  • Linting
  • Reporting
  • Extensions
• Django Model Search Tool
  • Overview
  • The Safelist
  • Coverage
  • Lint and Report
  • Local Models
• Configuration
• Extensions
• Testing
• Package Reference
  • code_annotations package
• Change Log
  • Unreleased
  • [2.0.0] - 2024-10-18
  • [1.8.1] - 2024-07-11
  • [1.8.0] - 2024-03-31
  • [1.6.0] - 2024-01-31
  • [1.5.0] - 2023-07-21
  • [1.4.0] - 2022-05-23
  • [1.3.0] - 2022-02-07
  • [1.2.0] - 2021-07-26
  • [1.1.2] - 2021-05-21
  • [1.1.1] - 2021-03-30
  • [1.1.0] - 2021-01-28
  • [1.0.2] - 2021-01-22
  • [1.0.1] - 2021-01-22
  • [1.0.0] - 2021-01-21
  • [0.10.3] - 2020-12-15
  • [0.10.1] - 2020-11-09
  • [0.10.0] - 2020-10-12
  • [0.9.0] - 2020-09-25
  • [0.8.0] - 2020-09-10
  • [0.7.0] - 2020-09-07
  • [0.6.0] - 2020-08-27
  • [0.5.1] - 2020-08-25
  • [0.5.0] - 2020-08-06
  • [0.4.0] - 2020-07-22
  • [0.3.4] - 2020-05-06
  • [0.3.2] - 2019-06-21
  • [0.3.1] - 2019-03-20
  • [0.1.0] - 2018-11-16

Contrib Code

• Annotations Config and Tools
  • Status
  • Context
  • Decision
  • Consequences
• How to: Add new annotations and extracted docs
  • Example annotations and automated docs
  • Add your own annotations and docs
• Sphinx extensions
  • featuretoggles
  • settings
• How to: Documenting Django settings
  • Types of Django Settings
  • Example Documentation
  • Additional details
  • Additional resources

Indices and tables

• Index

• Module Index

• Search Page