[FEA]: Move doc-building to more standard tooling
Nessuno ha ancora preso questa issue.
- Lingua principale
- Cython
- Stelle
- 3.4k
- Fork
- 329
- Merge medio
- 1g 23h
- PR unite (30g)
- 116
Descrizione
Is this a duplicate?
- I confirmed there appear to be no duplicate issues for this request and that I agree to the Code of Conduct
Area
Infrastructure
Is your feature request related to a problem? Please describe.
The requirements for doing a docs build are currently both in toolshed/setup-docs-env.sh and cuda_python/docs/environment-docs.yml, both of which are conda-specific. Instead, we should define these dependencies as a docs group in cuda_python/pyproject.toml, and have all the other pyproject.tomls point to that.
Additionally, there are build_docs.sh scripts that define a few environment variables etc., and the docs builds fail if you don't do that. For bonus points, it would be great to integrate what this does inside of conf.py so that the docs could be built in the standard way, and all of the extra commands in the Sphinx Makefile would work.
Describe the solution you'd like
pip install ./cuda_bindings[doc] would install the dependencies to build the docs, even in non-conda-based environments.
cd cuda_bindings/docs
make pdf
would work.
Describe alternatives you've considered
No response
Additional context
No response
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia confrontando toolshed/setup-docs-env.sh, cuda_python/docs/environment-docs.yml, gli script build_docs.sh e cuda_python/pyproject.toml. Verifica in che modo Sphinx conf.py e Makefile dipendono attualmente dalla configurazione dell’ambiente, quindi prova il flusso richiesto pip install ./cuda_bindings[doc] e cd cuda_bindings/docs; make pdf. Il lavoro è completato quando le dipendenze della documentazione sono definite tramite pyproject.toml e la build PDF standard funziona senza una configurazione specifica per conda.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- build-system, documentation, infrastructure
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100