eiffel-community / eiffel-community/eiffel-pythonlib

Readthedocs not generating properly

Ouverte
#9 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
bug documentation
Langage dominant
Python
Étoiles
8
Forks
12
Métriques de merge des PR
Aucune PR mergée en 30 j

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par docs/examples.rst à la ligne 10 et README.rst à la ligne 40, puis reproduisez le build de la documentation de Read the Docs afin d’inspecter les avertissements code-block. Vérifiez que les directives aux deux emplacements respectent la syntaxe documentée, et considérez le travail comme terminé lorsque le build se termine sans ces avertissements.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
docker
Domaine
build-system, documentation
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
58/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.