techwri / techwritersru

Сайт для технических писателей под открытой лицензией
https://techwriters.ru
5 stars 3 forks source link

Добавить линтеры #24

Open techwri opened 1 year ago

techwri commented 1 year ago

Добавить линтер pre-commit для проверки форматирования и ссылок

  1. добавить в файл requirements.txt расширение pre-commit-config
  2. Добавляем в корень проекта файл .pre-commit-config.yaml и описываем правила проверок
dunmaksim commented 1 year ago

Проблему можно решить с помощью pre-commit следующим образом:

  1. Добавляем в корень проекта .pre-commit-config.yaml.
  2. Описываем правила для Stylelint и других статических анализаторов.
  3. Для проверки ссылок используем Docker-образ, в Sphinx "из коробки" есть команда для этого.

    Но есть одна проблема: сам образ надо будет переработать. Сейчас используется Python-образ, а лучше взять sphinxdoc/sphinx и собирать с его помощью.

techwri commented 1 year ago

обновил описание этой задачи и создал задачу на обновление докер- образа #38