Investigate ReadTheDocs to ease documentation readability
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
No se nombran archivos ni pruebas. Empieza revisando cómo se publica actualmente en GitHub Pages la documentación de API generada por Sphinx y, a continuación, investiga el tema y la plataforma de ReadTheDocs, incluidos los compromisos entre el control de versiones y el alojamiento; se considera terminado cuando se hayan documentado los beneficios, las preocupaciones y una recomendación para su aprobación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is there an existing issue for this?
- I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?
This work needs to be approved first.
From a discussion with @dee-ynput and @mkolar it looks like readthedocs (theme and/or platform) might be beneficial for the automated API docs generated through Sphinx.
This could be investigated to assess the benefit/concerns.
How would you imagine the implementation of the feature?
No precise idea yet, it could be simply use the ReadTheDocs theme with sphinx or bringing more in order to get versioning feature automatically there for free.
We need to see if everything can remain on GitHub pages in order to not multiplying the host platforms tho..
Are there any labels you wish to add?
- I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:
No response
Additional context:
No response
- Lenguaje dominante
- Python
- Estrellas
- 16
- Forks
- 15
- Merge medio
- 1 d 9 h
- PR fusionados (30 d)
- 10
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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 ynput/ayon-python-api
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
ynput/ayon-python-api#351 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
ynput/ayon-python-api#350 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
ynput/ayon-python-api#199 ·
-
ynput/ayon-python-api#198 · 1 asignado ·
-
Implement ayon uris endpoint Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 50/100
ynput/ayon-python-api#182 ·
Todos los issues de ynput/ayon-python-api
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100