MetOffice / MetOffice/CMEW

Add Sphinx AutoAPI to create documentation for python code

Open
#146 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
5
Forks
3
Avg merge
5d 6h
Merged PRs (30d)
8

Description

We should introduce [Sphinx AutoAPI](https://sphinx-autoapi.readthedocs.io/en/latest/) to automatically generate API documentation from the docstrings of python code within the repository.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or documentation entry points are named. Start by reading the linked Sphinx AutoAPI documentation and locating the repository's documentation configuration; define the generated API documentation scope and verify that it builds from the Python docstrings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.