Unified documentation
@allgoodpnw ya está trabajando en esto.
Desde el 25/9/2024.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 3
- Forks
- 6
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de driplineorg/dripline-python
-
Log on set delayAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
driplineorg/dripline-python#222 · 1 comentario ·
-
Create Logging WrapperAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 30/100
driplineorg/dripline-python#221 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 50/100
driplineorg/dripline-python#214 · 2 comentarios ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
driplineorg/dripline-python#207 ·
-
Inconsistent response behavior with a 'values' arrayQuizá libre de nuevo @pkolbeck la tomó hace 484 días y no hay ningún pull request abierto. Abierto
driplineorg/dripline-python#204 · 1 comentario · 2 asignados ·
Todos los issues de driplineorg/dripline-python
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
huggingface/sentence-transformers#4186 ·
Los mantenedores suelen responder en 5 días
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
QuantEcon/QuantEcon.py#988 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
fabriziosalmi/certmate#1247 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
documentation good first issue
Dificultad 2/5 Medio día Aptitud para principiantes 72/100
sujithputta02/Esapay#13 ·