search

OpenMined / SyferText

A privacy preserving NLP framework
Apache License 2.0
198 stars 49 forks source link

Documentation Added #164

Closed hershd23 closed 4 years ago

hershd23 commented 4 years ago

Description

Documentation of SyferText, currently linked to my localfork(branch tests) can be found here

https://syfertext.readthedocs.io/en/tests/index.html

Affected Dependencies

The list of dependencies can be found in docs/requirements.txt

How has this been tested?

Checklist

Nilanshrajput commented 4 years ago

Nice work, one issue is can you change the order of files and methods as they are defined not alphabetically

autodoc_member_order = 'bysource' https://stackoverflow.com/questions/37209921/python-how-not-to-sort-sphinx-output-in-alphabetical-order

hershd23 commented 4 years ago

Member order is now done by source and I have also included private and special functions. Take a look once it's built maybe we would not need all those functions to be listed. Let me know if anything has to be excluded from the docs

Nilanshrajput commented 4 years ago

@hershd23 one thing, update the readme also, link this documentation website in readme.

hershd23 commented 4 years ago

I'll add the version number in the project name itself.

Also right now the Readthedocs page is linked to my local fork. Once the changes get merged, I'll do the same for the syfertext 0.1.0 branch. I'll then add the actual link in the README