eiffel-community / eiffel-community/eiffel-pythonlib

Readthedocs not generating properly

Aperta
#9 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
bug documentation
Lingua principale
Python
Stelle
8
Fork
12
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### 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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.