build-docs

name	build-docs
description	Guide for building documentation and validating docstrings. Use this when asked to build docs, check docstrings, or validate documentation.

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	sphinx_rtd_theme
Hosting	ReadTheDocs
Source location	docs/source/
Build output	docs/build/html/
Config	docs/source/conf.py

---

Building Documentation Locally

Prerequisites

Install documentation dependencies:

pip install -r docs/requirements.txt

Build Commands

# Navigate to docs directory
cd docs

# Generate API documentation from source code
sphinx-apidoc -f -o  ../src/sempy_labs/


make html


make.bat html