Unified documentation
@allgoodpnw ci sta già lavorando.
Dal 25/9/2024.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
The dripline-python package is divided between (1) C++ code with python bindings and (2) pure python code built on top of the bound code. From a user perspective, this appears all as one dripline package because the bound code, as a package called _dripline, is imported into the dripline package.
We want to have a unified documentation interface too. Everything that's available as part of the dripline package should be documented together as a single package, rather than having separate documentation for (1) and (2) [above].
Ideally the processes for maintaining the documentation would be as minimal as possible. There will be some rst source files in the doc directory, and then there will be all of the docstrings in both (1) and (2). Building of the documentation is done by readthedocs.
Building sphinx documentation out of bound C++ code is a thing -- see this pybind11 documentation. Binding the pure python code should be straight-forward Sphinx documentation. Then the trick is how to get it all to work together as one package documentation.
- Lingua principale
- Python
- Stelle
- 3
- Fork
- 6
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Nessuna 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.
Altre issue di driplineorg/dripline-python
-
Log on set delayAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
driplineorg/dripline-python#222 · 1 commento ·
-
Create Logging WrapperAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
driplineorg/dripline-python#221 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 50/100
driplineorg/dripline-python#214 · 2 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
driplineorg/dripline-python#207 ·
-
Inconsistent response behavior with a 'values' arrayForse di nuovo libera @pkolbeck l’ha presa 484 giorni fa e non c’è nessuna pull request aperta. Aperta
driplineorg/dripline-python#204 · 1 commento · 2 assegnatari ·
Tutte le issue di driplineorg/dripline-python
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
common-workflow-language/cwl-utils#477 ·
I maintainer di solito rispondono entro 1 giorno
-
Add dependabotApertafeat
Difficoltà 2/5 Meno di un'ora Idoneità per principianti 72/100
open-nudge/opentemplate#204 ·
I maintainer di solito rispondono entro 1 giorno
-
github-stale-ci-pr-closer: KV state is double-wrapped, never persists, and hits the depth-32 limitForse già presa @VascoSch92 l’ha presa oggi. Apertapriority:medium ready-for-dev
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
OpenHands/extensions#781 ·
I maintainer di solito rispondono entro 1 giorno
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
curriculum documentation quality
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
githubnext/gh-aw-workshop#4638 ·
I maintainer di solito rispondono entro 1 giorno