Skip to content

Commit

Permalink
Инструкция по генерации документации
Browse files Browse the repository at this point in the history
  • Loading branch information
Tiendil committed Nov 13, 2017
1 parent 95728ec commit c6182bc
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,17 @@
Документация ведётся в формате [reStructuredText](https://ru.wikipedia.org/wiki/ReStructuredText) генерируется с помощью [Sphinx](http://www.sphinx-doc.org).

[Документация по reStructuredText на английском](http://docutils.sourceforge.net/docs/user/rst/quickref.html)

[Документация по reStructuredText на русском](https://www.komtet.ru/lib/plangs/python/vvedenie-v-rst-formatirovanie)

## Генерация документации

```
cd ./my-project/
pip install -r requirements.txt
cd ./docs
make html
your-browser ./build/html/index.html
```

0 comments on commit c6182bc

Please sign in to comment.