Are API docs needed for this repo?
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading docs/sphinx-build.sh, .github/workflows/httomo_backends_docs.yml, and docs/index.rst to trace how API output is generated and published. Review the scripts under httomo_backends/ and the referenced httomo issue before deciding whether API documentation belongs here. Done means the repository has an agreed API-documentation scope and its build and index configuration consistently reflect that decision.
Written by the indexing model from the issue text.
Description
There's API docs being generated in the sphinx-build.sh script: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/docs/sphinx-build.sh#L27-L28
and similarly in the CI: https://github.com/DiamondLightSource/httomo-backends/blob/a34bf5802fc541ef5a0c541377b000ce596882aa/.github/workflows/httomo_backends_docs.yml#L34-L35
but the output rst files from this aren't being included in index.rst (so the API docs aren't included in the final docs deployment).
So that's one reason why I'm questioning if API docs are needed for this repo, because they're being built but not being used in the final docs deployment.
Another reason is if this repo needs API docs. At the moment, there's a handful of scripts used for generating the YAML templates, and that's it. The httomo_backends/ dir isn't even a python package (there's no __init__.py file), so there's no python modules in this repo really, just some scripts for generating YAML templates.
One question is: do we need/want API docs for the handful of scripts currently here?
Another question: for stuff that gets moved to httomo-backends (such as memory estimators and padding calculators from httomo, see https://github.com/DiamondLightSource/httomo/issues/429), would we like API docs for those? At the moment in httomo, memory estimators are private functions where they reside, but I imagine that when they get moved into httomo-backends they'll be made public functions - which may make sense to have API docs as they're public, but may also not make sense to have API docs, because they all have the same interface (parameters), and their usage is made obvious by how they are used in httomo. In which case, perhaps API docs in httomo-backends isn't really needed, but rather, general documentation on how the memory estimator and padding calculator functions are used in httomo/how they hook into httomo.
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DiamondLightSource/httomo-backends
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
documentation question
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 45/100
All issues in DiamondLightSource/httomo-backends
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
task
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
danparshall/claude_researcher#87 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
datajoint/datajoint-python#1586 ·
Maintainers usually reply within 1 day
-
1D intercept of length 1 is accepted as `fix_params` in population GLM with more than 1 unitPossibly taken @dhvani7014 claimed this today. Openbug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
flatironinstitute/nemos#642 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
uniswap-python/uniswap-python#487 ·