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

Remplacement de settings.py dans la documentation (#6707) #6708

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

Convolutio
Copy link

Un fichier settings.py est mentionné dans la documentation pour contenir des éléments de configuration tandis qu'ils sont situés dans le fichier zds/settings/abstract_base/django.py

settings.py a été temporairement laissé pour les champs de configuration de la pagination, dont le véritable emplacement n'a pas été trouvé.

Fix #6707

Contrôle qualité

  • Recharger la documentation avec make generate-doc
  • Servir la page de documentation avec python3 -m http.server 8080 -d doc/build/html/
  • Observer les changements depuis le navigateur à la page localhost:8080/api

Un fichier `settings.py` est mentionné dans la documentation
pour contenir des éléments de configuration tandis qu'ils sont situés
dans le fichier `zds/settings/abstract_base/django.py`

`settings.py` a été laissé pour les champs de configuration de
la pagination, dont le véritable emplacement n'a pas été trouvé.
@coveralls
Copy link

Coverage Status

coverage: 89.21%. remained the same
when pulling 0212f4c on Convolutio:feature-6707
into 544dd75 on zestedesavoir:dev.

@philippemilink
Copy link
Member

settings.py a été temporairement laissé pour les champs de configuration de la pagination, dont le véritable emplacement n'a pas été trouvé.

La partie de la doc concernant la pagination ne semble pas du tout à jour, la dernière mention de PAGINATE_BY_PARAM est dans le commit addf026 (qui date de 2016 !).

Il faudrait donc en profiter pour mettre cette partie de la doc à jour. J'ai l'impression qu'il suffit de reprendre ce qui est mentionné dans la doc officielle de DjangoRestFramework concernant la pagination (le lien est déjà dans la doc de ZdS) et dire que c'est comme ça qu'on l'utilise dans ZdS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Modification demandée
Development

Successfully merging this pull request may close these issues.

Supprime le fichier settings.py de la documentation
3 participants