Thanks Dmitry. I'll look at the docs. On Wed, Jul 25, 2018 at 8:11 PM, Dmitry Melnichuk < dmitry.melnic...@nobitlost.com> wrote:
> Hi Prachi! > > At the moment I already have my documents (temporarily) published at RTD. > This is how they look like at a whole: > > https://apache-ignite-binary-protocol-client.readthedocs.io/ > > I already have a separate section on examples: > > https://apache-ignite-binary-protocol-client.readthedocs.io/ > en/latest/examples.html > > My build process is also documented here > > https://apache-ignite-binary-protocol-client.readthedocs.io/ > en/latest/readme.html#documentation > > and there > > https://github.com/nobitlost/ignite/blob/ignite-7782/modules > /platforms/python/README.md > > This instructions works for me, and I have at least one report of > successful documentation build from elsewhere. And RTD is using basically > the same way to put my docs online. > > My way of document building is pretty common for Python package > developers, but if it needs some modifications to fit into Ignite process, > please let me know. > > All the document sources (both autodoc'ed and hand-crafted) is available at > > https://github.com/nobitlost/ignite/tree/ignite-7782/modules > /platforms/python/docs > > I will be glad to answer any questions. > > > On 07/26/2018 06:25 AM, Prachi Garg wrote: > >> Hi Dmitry M, >> >> I am resposible for managing the Ignite documentation. At some point we >> will merge the python documentation on github into the main Ignite >> documentation. Currently, I am trying to restructure our thin client >> documentation in a way that it (thin client documentation) is consistent >> for all supported languages - Java, Node.js, Python etc. >> >> I looked at the python document on github. Under the :mod:`~pyignite.api` >> section, I see all the components - cache config, key value, sql, binary >> types - but there are no code snippets. Is it possible for you describe >> these components with code examples? >> >> See for example - >> https://apacheignite.readme.io/docs/java-thin-client-api#sec >> tion-sql-queries >> where the SQL Queries section explains, with example, how the thin client >> SQL API can be used. >> >> Similarly, please see - >> https://apacheignite.readme.io/docs/java-thin-client-security >> https://apacheignite.readme.io/docs/java-thin-client-high-availability >> https://apacheignite.readme.io/docs/java-thin-client-api >> >> Thanks, >> -Prachi >> >
