Skip to content
This repository has been archived by the owner on Jul 7, 2022. It is now read-only.

Перенести README из md в rst #19

Open
ya7on opened this issue Aug 5, 2019 · 0 comments
Open

Перенести README из md в rst #19

ya7on opened this issue Aug 5, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@ya7on
Copy link
Owner

ya7on commented Aug 5, 2019

Нужно оставить только один README вместо имеющихся сейчас двух (md и rst).

  1. Markdown формат не поддерживается в PyPi, поэтому его оставлять не очень хочется.
  2. reStructuredText поддерживается PyPi и GitHub, и имеет подстветку синтаксиса для питона, поэтому останавливаемся на нём.

Сейчас вся имеющаяся документация находится в README.md. Можно попробовать использовать автоматические конвертеры из markdown в restructuredtext, если таковые имеются.

@ya7on ya7on added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 5, 2019
@ya7on ya7on added this to the Release 1.1 milestone Aug 5, 2019
@ya7on ya7on changed the title Move README from md to rst Перенести README из md в rst Aug 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant