astropy / astropy/sphinx-automodapi

Improve performance

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

In addition to #13, it would be good to do some profiling to see if there are any easy optimizations, since generating the API docs for a project like Astropy can currently be very slow.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading issue #13 and profiling API-document generation for a project like Astropy, as described in the issue. Identify whether there are easy optimizations and establish how performance should be measured; the issue does not name files, tests, or a specific completion criterion.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, performance
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.