Mimesis: Update documentation.

Created on 15 Jul 2017  路  18Comments  路  Source: lk-geimfari/mimesis

We need update documentation again. I suggest generate documentation with Sphinx again.

enhancement

All 18 comments

Looks like our old documentation does not work. We need generate documentation automatically from docstring.

@Valerievich Your help would be very handy. I'll work on locale ru. I want to update some data.

@lk-geimfari OK, I'll do it. I'll start after finish with ee locale. I need a few days for it.

@Valerievich I think that code of Estonian language is et, not ee. It's just a note. Thank you!

Thanks, I thought we use this code list.

@Valerievich I found Sphinx documentation in Russian. I thinks that is would helpful.

@lk-geimfari Please tell me what exactly you expects from this issue?
We already have Sphinx makefile in \docs. So I can just execute make html and get new ver. of documentation. Would it be enough?

@Valerievich Actually it should work, but i'm not sure. If it's works then it's okay. We need generate API Reference automatically from docstrings.

You can see what I've got. I used current ver. conf.py. Docstrings are there. autodoc is included.
html.zip

@Valerievich Unfortunately, only partially. There no new providers, such as Cryptographic(). Also we need .rst format, which easy to edit.

@Valerievich Can you do it? Please generate autodoc for all providers (.rst format) and it's all.

I'll fix it

@Valerievich Thank you!

@lk-geimfari Did you create api.rst, guide.rst manually last time?

@Valerievich Only guide.rst. As far as I remember, api.rst was created automatically.

My solution is in PR #223

Seems like we have some issue in the table of contents. I'll try fix it ASAP.

I understood where is error. We had an interpreter of version 2.7, at the same time in the code for some functions annotations are used, which are the features of Python 3.x. I have changed the interpreter to CPython 3.x and everything is ok!

We need to update documentation again.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

lk-geimfari picture lk-geimfari  路  6Comments

lk-geimfari picture lk-geimfari  路  6Comments

faheel picture faheel  路  4Comments

kairichard picture kairichard  路  6Comments

4kpt picture 4kpt  路  7Comments