Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ReadTheDoc ne compile plus notre documentation #2483

Closed
pierre-24 opened this issue Apr 3, 2015 · 21 comments
Closed

ReadTheDoc ne compile plus notre documentation #2483

pierre-24 opened this issue Apr 3, 2015 · 21 comments
Assignees
Labels
C-Docs Concerne la documentation S-BUG Corrige un problème
Milestone

Comments

@pierre-24
Copy link
Member

L'heure est grave. #2451, qui était sencé améliorer notre documentation, l'a toute cassée, alors qu'elle compile très bien chez moi, chez artragis et @firm1 avait même réussi à la déployer sur un serveur.

Deux solutions: soit il y a un truc qui va pas chez ReadTheDoc (mais j'arrive pas à voir si on a une version différente de sphinx par rapport à la leur), soit y'a un souchi avec Sphinx. La dernière option est la plus "inquiétante".

Un peu de lecture:

Et pour tester ça, ça va pas être facile, par ailleurs (va falloir faire des pushs sur une branche sur laquelle RTD est activé).

@pierre-24
Copy link
Member Author

Note: RTD semble coincer sur ce fichier en nous crachant une erreur d'encodage. Ce fichier est le premier de la série a employer autodoc pour lire le docstring. C'est très probablement lié.

@artragis
Copy link
Member

artragis commented Apr 3, 2015

ALors c'est étrange :

  • au boulot (ubuntu 14.04) je n'ai pas ce problème
  • chez moi (xubuntu 14.10) je l'ai.

j'ai observé le fichier et rien n'indique la présence d'un unicode...
ça pue le nom de local mal configure

chez moi ça dit ça :

LANG=fr_FR.UTF-8
LANGUAGE=fr_FR
LC_CTYPE="fr_FR.UTF-8"
LC_NUMERIC="fr_FR.UTF-8"
LC_TIME="fr_FR.UTF-8"
LC_COLLATE="fr_FR.UTF-8"
LC_MONETARY="fr_FR.UTF-8"
LC_MESSAGES="fr_FR.UTF-8"
LC_PAPER="fr_FR.UTF-8"
LC_NAME="fr_FR.UTF-8"
LC_ADDRESS="fr_FR.UTF-8"
LC_TELEPHONE="fr_FR.UTF-8"
LC_MEASUREMENT="fr_FR.UTF-8"
LC_IDENTIFICATION="fr_FR.UTF-8"
LC_ALL=

@pierre-24
Copy link
Member Author

Bon, moi j'ai ça (Debian/Jessie)

pierre@pc:~$ locale
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_CTYPE="en_US.UTF-8"
LC_NUMERIC="en_US.UTF-8"
LC_TIME="en_US.UTF-8"
LC_COLLATE="en_US.UTF-8"
LC_MONETARY="en_US.UTF-8"
LC_MESSAGES="en_US.UTF-8"
LC_PAPER="en_US.UTF-8"
LC_NAME="en_US.UTF-8"
LC_ADDRESS="en_US.UTF-8"
LC_TELEPHONE="en_US.UTF-8"
LC_MEASUREMENT="en_US.UTF-8"
LC_IDENTIFICATION="en_US.UTF-8"
LC_ALL=

Forcément, mon PC étant en anglais, j'ai la locale anglaise partout. Je sais plus pourquoi, mais la doc précise à un moment qu'on doit avoir la locale française pour que ça fonctionne. Donc je l'ai aussi :

pierre@pc:~$ locale -a
C
C.UTF-8
en_US.utf8
fr_BE.utf8
fr_FR.utf8
POSIX

Va savoir ^^

@pierre-24
Copy link
Member Author

(je peux m'amuser à switcher au français pour tester, si ça vous amuse)

@artragis
Copy link
Member

artragis commented Apr 4, 2015

J'ai trouvé !

ça foire avec python 2.7.8

ça marche avec python 2.7.9 !

@pierre-24
Copy link
Member Author

Ah. Intéréssant :) ... Bon, comment qu'on met la bonne version de python chez RTD ?

@artragis
Copy link
Member

artragis commented Apr 4, 2015

et du coup je sais pas pourquoi ça foire avec 2.7.8.

@pierre-24
Copy link
Member Author

Le bug a, on dirait, évolué. Soit ça passe, mais il se plaint qu'il trouve pas GIT (sur v1.7-RC3); soit ça plante total (sur la version stable, donc je dirais la dev). Pour le premier cas, je crois qu'il y a un requirement a ajouter quelque part.

Dans tout les cas, what the f*** ???

@firm1
Copy link
Contributor

firm1 commented Apr 8, 2015

Sur dev :

J'ai rajouté le fichier requirements.txt a la conf de readthedocs, le résultat de la compilation donne ceci :

  • d'un coté il n'arrive pas a installer tous les paquets (dépendances systèmes pour compilations manquants)
  • de l'autre coté on dirait que python-zmarkdown est pas bien packagé pour lui.

J'ai alors, demandé à ce qu'il passe non plus par le requirements.txt mais pas le setup.py pour tout installer, et là il s'en sort plutot pas mal. Il ne reste que les warnings suivants :

/var/build/user_builds/zds-site/checkouts/stable/doc/source/utils/templatetags.rst:111: WARNING: Inline substitution_reference start-string without end-string.
/var/build/user_builds/zds-site/checkouts/stable/doc/source/utils/templatetags.rst:121: WARNING: Inline substitution_reference start-string without end-string.
/var/build/user_builds/zds-site/checkouts/stable/doc/source/utils/templatetags.rst:137: WARNING: Inline substitution_reference start-string without end-string.
/var/build/user_builds/zds-site/checkouts/stable/doc/source/install/includes/git-pre-hook.rst:: WARNING: document isn't included in any toctree
WARNING: html_static_path entry u'/var/build/user_builds/zds-site/checkouts/stable/doc/source/_static' does not exist

@pierre-24
Copy link
Member Author

Il s'en sort effectivement assez bien, ça, ça a l'air d'être des typos dans nos docstrings. Par contre, j'arrive pas à voir le résultat (et si le résultat est celui-là, il nous plante encore la moitié des docstrings)

@firm1
Copy link
Contributor

firm1 commented Apr 8, 2015

Ton lien pointe sur la Relase 1-7 alors que mon buid a été fait sur la dev.

Je m'en vais relancer le build de la release pour voir

@pierre-24
Copy link
Member Author

Si "latest", c'est "dev", la constatation est la même :'(

@firm1
Copy link
Contributor

firm1 commented Apr 8, 2015

En effet, je n'ai pas regardé plus en détail, je vais voir ce qu'il en journée. Mais ayant essayer la compil en local, ça ne marche pas non plus. J'ai des warnings aussi

@pierre-24
Copy link
Member Author

J'ai les warning sur v1.7-RC3 (mais c'est encore la vieille doc). Et sur upstream/dev, je compile sans problème. What the f*********** !!!!

screenshot from 2015-04-07 20 25 44

@firm1
Copy link
Contributor

firm1 commented Apr 8, 2015

Bon visiblement il n'arrive pas à compiler lastest non plus qui fait reférence à dev. a cause de la nouvelle lib GeoIP

@pierre-24
Copy link
Member Author

Ah. Intéréssant (oui, je sais, j'arrive deux jour plus tard). On sait faire quelque chose pour ça ? (à part aller raler chez RTD ?)

@Eskimon Eskimon added S-BUG Corrige un problème C-Back Concerne le back-end Django labels Apr 21, 2015
This was referenced Apr 28, 2015
@Eskimon Eskimon mentioned this issue Apr 30, 2015
@SpaceFox
Copy link
Contributor

SpaceFox commented May 3, 2015

J'ai mergé le revert de GeoIP, par contre je ne sais pas si ça règle le problème ici.

@pierre-24
Copy link
Member Author

On ne le saura que quand #2616 sera réglé, mais je pense que ça va nettement améliorer le truc, donc d'avance merci ;)

@firm1
Copy link
Contributor

firm1 commented May 4, 2015

Par ailleurs, notons que la documentation de la v15.5 est HS, elle ne compile pas non plus

@pierre-24
Copy link
Member Author

... J'en ai marre. Vraiment, là.

@pierre-24 pierre-24 added C-Docs Concerne la documentation and removed C-Back Concerne le back-end Django labels May 12, 2015
@Eskimon
Copy link
Contributor

Eskimon commented May 14, 2015

Cay bon :) Merci @pierre-24 pour toute l'investigation !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs Concerne la documentation S-BUG Corrige un problème
Projects
None yet
Development

No branches or pull requests

5 participants