diff options
| author | Laurent Peuch <cortex at worlddomination.be> | 2019-05-23 14:32:19 +0200 |
|---|---|---|
| committer | Laurent Peuch <cortex at worlddomination.be> | 2019-05-23 14:32:19 +0200 |
| commit | c2391a4f570213d63a32d44374a73d33dc371d89 (patch) | |
| tree | 3499b55b0d1a8c4fbf365e06aa61c69bf556fa5d /.hgignore | |
| parent | 694eca30969121c0966abd4c60a0f3ecdadb65fd (diff) | |
| download | logilab-common-c2391a4f570213d63a32d44374a73d33dc371d89.tar.gz | |
[doc] migrate documentation to sphinx using sphinx-apidoc and including README
The rationnal to do this migration are:
* be able to host the documentation on readthedocs.org, right now, according to
the README, the user needs to built it locally to be able to read it
* epydoc is not maintained anymore
* sphinx generally offer a better user experience and allow to write real
documentation instead of just generating an API
* it was quick to do with sphinx-apidoc and seems worth it to be able to put it
online
Diffstat (limited to '.hgignore')
| -rw-r--r-- | .hgignore | 1 |
1 files changed, 1 insertions, 0 deletions
@@ -9,3 +9,4 @@ \,cover$ ^\.coverage$ ^.tox$ +doc/_build/ |