Add the sphinx-codeautolink extension to the doc build process?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
I am proposing to include the https://github.com/felix-hilden/sphinx-codeautolink Sphinx extension into the documentation build process. This extension makes parseable Python code examples clickable so that it's easy to jump to the reference documentation of an object.
Related thread: https://discuss.python.org/t/add-the-sphinx-codeautolink-extension-to-doc-build-process/80814/11
A pull request to add the extension is upcoming.
Linked PRs
- gh-134896
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Konfiguration für den Dokumentations-Build und das im Issue verlinkte Projekt sphinx-codeautolink zu überprüfen, und lies anschließend den zugehörigen Thread auf discuss.python.org und PR gh-134896. Erledigt ist die Aufgabe, wenn die Erweiterung in den Dokumentations-Build aufgenommen ist und parsbare Python-Beispiele zu klickbaren Links zur Referenzdokumentation werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100