eiffel-community / eiffel-community/eiffel-pythonlib

Readthedocs not generating properly

Abierto
#9 0 comentarios 0 reacciones 0 asignados Ver en GitHub
bug documentation
Lenguaje dominante
Python
Estrellas
8
Forks
12
Métricas de merge de PR
Sin PR fusionados en 30 d

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

Guía de contribución

Abrir la guía de contribución

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.

Evaluación

Stack tecnológico
docker
Área
build-system, documentation
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
58/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.