eiffel-community / eiffel-community/eiffel-pythonlib

Readthedocs not generating properly

Open
#9 0 comments 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Python
Stars
8
Forks
12
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.