open-telemetry / open-telemetry/opentelemetry-python-genai
Set up Read the Docs hosting for this repo
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 39
- Forks
- 63
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 175
Description
The repo already contains all the in-tree docs infrastructure:
.readthedocs.yml,docs/conf.py,docs/index.rst,docs/instrumentation/*.rstrtd-requirements.txt/docs-requirements.txt- A CI
docsjob (tox -e docs) that builds the docs on every PR
What's missing is the Read the Docs project itself. https://opentelemetry-python-genai.readthedocs.io/ currently returns 404 — no RTD project is registered for this repo, so docs are never published.
This requires an action by someone with OpenTelemetry org admin access (outside the repo):
- Create a Read the Docs project for
open-telemetry/opentelemetry-python-genai(matching the existing slugopentelemetry-python-genaiso existing links resolve). - Connect the GitHub webhook so pushes to
mainand tags trigger builds. - Verify the build succeeds and
latestresolves.
Contributor guide
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.
Research direction
Review .readthedocs.yml, docs/conf.py, docs/index.rst, and the existing tox -e docs CI job first. An OpenTelemetry organization admin must register the matching Read the Docs project, connect the GitHub webhook, and verify that the build succeeds and the latest URL resolves.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100