NVIDIA / NVIDIA/cuda-python

[FEA]: Move doc-building to more standard tooling

Offen
#1,152 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

CI/CD documentation packaging
Vorherrschende Sprache
Cython
Sterne
3.4k
Forks
329
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
116

Beschreibung

Is this a duplicate?
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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Vergleich von toolshed/setup-docs-env.sh, cuda_python/docs/environment-docs.yml, den build_docs.sh-Skripten und cuda_python/pyproject.toml. Prüfe, wie Sphinx conf.py und Makefile derzeit von der Einrichtung der Umgebung abhängen, und teste anschließend den angeforderten Ablauf pip install ./cuda_bindings[doc] und cd cuda_bindings/docs; make pdf. Die Aufgabe ist erledigt, wenn die Dokumentationsabhängigkeiten über pyproject.toml definiert sind und der standardmäßige PDF-Build ohne conda-spezifische Einrichtung funktioniert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
build-system, documentation, infrastructure
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.