doc-warden 0.7.2

Doc-Warden is an internal project created by the Azure SDK Team. It is intended to be used by CI Builds to ensure that documentation standards are met. See readme for more details.

Stars: 106, Watchers: 106, Forks: 162, Open Issues: 1288

The Azure/azure-sdk-tools repo was created 5 years ago and the last code push was 6 hours ago.
The project is popular with 106 github stars!

How to Install doc-warden

You can install doc-warden using pip

pip install doc-warden

or add it to a project with poetry

poetry add doc-warden

Package Details

Author

Microsoft Corporation

License

MIT License

Homepage

https://github.com/Azure/azure-sdk-tools/

PyPi:

https://pypi.org/project/doc-warden/

GitHub Repo:

https://github.com/Azure/azure-sdk-tools

Classifiers

Related Packages

Errors

A list of common doc-warden errors.

Code Examples

Here are some doc-warden code examples and snippets.

GitHub Issues

The doc-warden package has 1288 open issues on GitHub

• remove greedy suffix on link check
• [Test-Proxy] BodyRegexSanitizer should not apply for binary content types
• Go ApiView omits most of azcore
• Expand the script get-changed-markdown-file.ps1
• [Test-Proxy] Flaky test - BodyKeySanitizer
• Live test subscription cleanup is failing for several subs on keyvault purge operation
• Support custom template paths for New-TestResources.ps1
• Fill ms.author metadata for docs.
• New-TestResources.ps1 script does not generate valid resource group base name with nested service directories
• Prevent panic on unnamed receiver
• Non stop on errors.
• fix incidentally added path addition
• C# Analyzers: Prevent mutation of customer provided ClientOptions objects
• Add go repo to pipeline failure notification automation
• Add TimeoutSec option to Verify-Links check

See more issues on GitHub