Mimesis: Required docs [Sphinx]

Created on 13 Sep 2016  路  7Comments  路  Source: lk-geimfari/mimesis

Very required the documentation, because at this moment we have only small guidebook.

help wanted

All 7 comments

If it's alright with you, I'll give it a shot.

@Battleroid Thank you! Let me know about your final decision, please.

I would like to do these work. Let me know that if there is any need of updating the docStrings or not. One more question about the example, do you want examples included in the docs or not? :rocket:

@arpit1997 I think that docstrings is actual and recently updated. Yes, it would be good to include examples in the documentation. Everything should be in the 'docs' folder (root of repository). Thanks!

I'm going through and trying to put together the Sphinx documentation now. Some of the docstrings have very minor formatting issues so I'll fix those as well if that's ok.

@Battleroid Sorry for issues in docstrings. Thank you for your contribution!

Submitted pull request #29

Was this page helpful?
0 / 5 - 0 ratings

Related issues

lk-geimfari picture lk-geimfari  路  5Comments

lk-geimfari picture lk-geimfari  路  4Comments

dumprop picture dumprop  路  6Comments

kairichard picture kairichard  路  6Comments

lk-geimfari picture lk-geimfari  路  4Comments