Readthedocs not generating properly
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 58/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- docker
- Área
- build-system, documentation
Línea de trabajo
Comienza con docs/examples.rst en la línea 10 y README.rst en la línea 40; después, reproduce la compilación de la documentación de Read the Docs para inspeccionar las advertencias de code-block. Comprueba que las directivas en ambas ubicaciones cumplen la sintaxis documentada y considera terminado el trabajo cuando la compilación finalice sin estas advertencias.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Description
Problem with generating docs in readthedocs. Works locally and on github.
The problem seems to be the empty "..code-block::" directive.
/home/docs/checkouts/readthedocs.org/user_builds/eiffellib/checkouts/stable/docs/examples.rst:10: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
# From https://hub.docker.com/_/rabbitmq
docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
../README.rst:40: WARNING: Error in "code-block" directive:
1 argument(s) required, 0 supplied.
.. code-block::
# From https://hub.docker.com/_/rabbitmq
docker run -d --hostname my-rabbit --name some-rabbit -p 8080:15672 -p 5672:5672 rabbitmq:3-management
looking for now-outdated files... none found
Motivation
Readthedocs documentation should always work.
Exemplification
Benefits
Working documentation
Possible Drawbacks
none
- Lenguaje dominante
- Python
- Estrellas
- 8
- Forks
- 12
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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 eiffel-community/eiffel-pythonlib
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 45/100
eiffel-community/eiffel-pythonlib#44 · 1 comentario ·
-
Add jq filtering to subscriberAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
eiffel-community/eiffel-pythonlib#31 · 1 comentario ·
-
on-hold
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
CHANGELOG.rst is outdatedAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
eiffel-community/eiffel-pythonlib#28 · 3 comentarios ·
Todos los issues de eiffel-community/eiffel-pythonlib
Issues similares
-
[Bug] Unit tests reach real Bedrock call paths without patching the modelPosiblemente ocupada @proton0210 la tomó hoy. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
aws-samples/sample-aws-genai-db-modernizer#1318 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
pyarrow-25.0.1-cp310-cp310-manylinux_2_28_x86_64.whl: 1 vulnerabilities (highest severity is: 5.3)AbiertoMend: dependency security vulnerability
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
capitalone/locopy#394 ·
-
[Bug] Unhandled ValueError terminates watchdog thread when GISRC value contains multiple colonsAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
sdk-typescript: unquoted COPY globs in shell form are silently dropped from the image build contextAbiertobug javascript
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
ietf-tools/datatracker#11922 · 1 comentario ·
Los mantenedores suelen responder en 1 día