build-docs Skill
Guide for building documentation and validating docstrings. Use this when asked to build docs, check docstrings, or validate documentation. Published by microsoft in semantic-link-labs.
What is build-docs Skill?
Guide for building documentation and validating docstrings. Use this when asked to build docs, check docstrings, or validate documentation. Published by microsoft in semantic-link-labs. This profile combines repository metadata with install, compatibility, and usage signals so developers can quickly decide whether it fits their agent workflow before opening the source repository.
Automated repository signals based on public metadata such as recency, license, installation evidence, and adoption. These are not a security audit or endorsement.
Key capabilities
- Includes SKILL.md support
- Reusable instructions support
- Documentation
- Documentation use cases
Technical details
- Install or run with Copy skill directory
When to use build-docs Skill
- Use it for documentation.
Built with
Editorial notes
Source
- Creator: microsoft
- Repository: microsoft/semantic-link-labs
- Skill file: .claude/skills/build-docs/SKILL.md
What it does
Guide for building documentation and validating docstrings. Use this when asked to build docs, check docstrings, or validate documentation.
Skill instructions
Building and Validating Documentation This skill covers documentation building and docstring validation workflows for the Semantic Link Labs project. When to Use This Skill Use this skill when you need to: - Build documentation locally - Validate docstrings are properly formatted - Check for documentation warnings or errors - Ensure new functions have proper documentation - Preview documentation before pushing --- Documentation Framework | Component | Details | |-----------|---------| | Framework | Sphinx with numpydoc | | Theme | sphinxrtdtheme | | Hosting | ReadTheDocs | | Source location | docs/source/ | | Build output | docs/build/html/ | | Config | docs/source/conf.py | --- Building Documentation Locally Prerequisites Install documentation dependencies: bash pip install -r docs/requirements.txt Build Commands bash Navigate to docs directory cd docs Generate API documentation from source code sphinx-apidoc -f -o source ../src/sempylabs/ Build HTML documentation make html Or on Wind
Explore related resources
Frequently asked questions
What is build-docs?
build-docs is a open-source AI agent skill with Copy skill directory. Guide for building documentation and validating docstrings. Use this when asked to build docs, check docstrings, or validate documentation.
Who is build-docs best for?
build-docs is best for reusing agent instructions, scripts, and references, documentation workflows.
How do I install build-docs?
Install or run build-docs using Copy skill directory. Check build-docs for the latest setup command.
Is build-docs actively maintained?
build-docs may need a closer maintenance check before production use.
Auto-fetched from GitHub.
