cds-snc / cds-snc/sre-bot

Refactor: Create Automatic Project Documentation

Open
#809 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
12
Forks
5
Avg merge
3h 28m
Merged PRs (30d)
60

Description

**Description:**
Set up tools for automatically generating project documentation from docstrings and module structure.

**Acceptance Criteria:**
- Set up Sphinx with autodoc for Python documentation
- Configure dependency graphs using pydeps
- Create a basic documentation structure with introductory content
- Add build scripts for documentation generation

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the Python package and module structure, then review how Sphinx autodoc and pydeps can represent it. Set up the documentation structure, dependency-graph configuration, and build scripts; done means introductory documentation builds successfully and reflects the project modules.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.