From 82e5e3c6454d8d736a10dca61b19624490d00733 Mon Sep 17 00:00:00 2001 From: Kai Schwarz Date: Thu, 12 Jul 2018 10:53:01 +0200 Subject: [PATCH] use of m2r and mdincludes - WOW --- docs/_build/html/_sources/changelog.rst.txt | 2 +- .../_build/html/_sources/contributing.rst.txt | 2 +- docs/_build/html/_sources/license.rst.txt | 2 +- docs/_build/html/api.html | 2 + .../_build/html/api/hexonet.apiconnector.html | 2 + docs/_build/html/changelog.html | 147 ++++++++++++------ docs/_build/html/config.html | 2 + docs/_build/html/contactus.html | 2 + docs/_build/html/contributing.html | 72 +++++++-- docs/_build/html/debugging.html | 2 + docs/_build/html/foreword.html | 2 + docs/_build/html/genindex.html | 2 + docs/_build/html/index.html | 15 +- docs/_build/html/installation.html | 2 + docs/_build/html/license.html | 22 ++- docs/_build/html/py-modindex.html | 2 + docs/_build/html/quickstart.html | 2 + docs/_build/html/search.html | 2 + docs/_build/html/searchindex.js | 2 +- docs/_build/html/upgrading.html | 2 + docs/changelog.rst | 2 +- docs/conf.py | 5 +- docs/contributing.rst | 2 +- docs/license.rst | 2 +- src/m2r | 1 + 25 files changed, 225 insertions(+), 75 deletions(-) create mode 160000 src/m2r diff --git a/docs/_build/html/_sources/changelog.rst.txt b/docs/_build/html/_sources/changelog.rst.txt index 2317c2d..77dd904 100644 --- a/docs/_build/html/_sources/changelog.rst.txt +++ b/docs/_build/html/_sources/changelog.rst.txt @@ -1,4 +1,4 @@ Changelog ========= -.. include:: ../HISTORY.md +.. mdinclude:: ../HISTORY.md diff --git a/docs/_build/html/_sources/contributing.rst.txt b/docs/_build/html/_sources/contributing.rst.txt index 1460c24..21261e9 100644 --- a/docs/_build/html/_sources/contributing.rst.txt +++ b/docs/_build/html/_sources/contributing.rst.txt @@ -3,4 +3,4 @@ Contributing ============ -.. include:: ../CONTRIBUTING.md +.. mdinclude:: ../CONTRIBUTING.md diff --git a/docs/_build/html/_sources/license.rst.txt b/docs/_build/html/_sources/license.rst.txt index 3fa7a01..35f3776 100644 --- a/docs/_build/html/_sources/license.rst.txt +++ b/docs/_build/html/_sources/license.rst.txt @@ -13,7 +13,7 @@ The full license text can be found below (:ref:`mit-license`). Authors ------- -.. include:: ../AUTHORS.md +.. mdinclude:: ../AUTHORS.md General License Definitions --------------------------- diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html index 8473edf..56d6ace 100644 --- a/docs/_build/html/api.html +++ b/docs/_build/html/api.html @@ -81,7 +81,9 @@

Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/_build/html/api/hexonet.apiconnector.html b/docs/_build/html/api/hexonet.apiconnector.html index 1d3c992..453b7ff 100644 --- a/docs/_build/html/api/hexonet.apiconnector.html +++ b/docs/_build/html/api/hexonet.apiconnector.html @@ -82,7 +82,9 @@

    Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/_build/html/changelog.html b/docs/_build/html/changelog.html index b898bbc..9de178b 100644 --- a/docs/_build/html/changelog.html +++ b/docs/_build/html/changelog.html @@ -76,15 +76,44 @@

    Table Of Contents

    +
    +
    +

    Contents

    +
    + + +
    +
    +
    +
    +
    +

    Contents

    +
    + + +
    +
    +
    diff --git a/docs/_build/html/installation.html b/docs/_build/html/installation.html index 2ccec16..64bc35a 100644 --- a/docs/_build/html/installation.html +++ b/docs/_build/html/installation.html @@ -83,7 +83,9 @@

    Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/_build/html/license.html b/docs/_build/html/license.html index 69581d9..3bb155d 100644 --- a/docs/_build/html/license.html +++ b/docs/_build/html/license.html @@ -79,11 +79,15 @@

    Table Of Contents

  • Changelog
  • License +
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • @@ -97,6 +101,9 @@

    Contents

    • License +
      • +
    • HEXONET Developers @@ -143,14 +150,17 @@

      LicenseMIT License).

      Authors

      -

      > ⚠ This document _only_ reflects the responsible developers at HEXONET GmbH. For a list of MUCH-APPRECIATED CONTRIBUTORS – people who helped developing and extending this library, applying patches, adding helpful comments -and thus generally made it that much better, see [GitHub’s list of contributors](https://github.com/hexonet/python-sdk/contributors).

      -

      # HEXONET Developers

      +
      +
      ⚠ This document only reflects the responsible developers at HEXONET GmbH. For a list of MUCH-APPRECIATED CONTRIBUTORS – people who helped developing and extending this library, applying patches, adding helpful comments +and thus generally made it that much better, see GitHub’s list of contributors.
      +
      +

    +
    +

    HEXONET Developers

      -
    • [Anthony Schneider](//github.com/isharky) - Original Implementation
      • -
    • [Kai Schwarz](//github.com/papakai) - Full Review
      • +
    • Anthony Schneider - Original Implementation
      • +
    • Kai Schwarz - Full Review
    -

    General License Definitions

    The following section contains the full license texts for this module and the diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html index 3cfd7de..0471411 100644 --- a/docs/_build/html/py-modindex.html +++ b/docs/_build/html/py-modindex.html @@ -73,7 +73,9 @@

    Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/_build/html/quickstart.html b/docs/_build/html/quickstart.html index e356f9c..ad9bed1 100644 --- a/docs/_build/html/quickstart.html +++ b/docs/_build/html/quickstart.html @@ -83,7 +83,9 @@

    Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index 5f613dd..d0b12b3 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -79,7 +79,9 @@

    Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 798d97b..964e824 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["api","api/hexonet.apiconnector","changelog","config","contactus","contributing","debugging","foreword","index","installation","license","quickstart","upgrading"],envversion:{"sphinx.domains.c":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:54},filenames:["api.rst","api/hexonet.apiconnector.rst","changelog.rst","config.rst","contactus.rst","contributing.rst","debugging.rst","foreword.rst","index.rst","installation.rst","license.rst","quickstart.rst","upgrading.rst"],objects:{"hexonet.apiconnector":{connect:[1,1,1,""],connection:[1,0,0,"-"],response:[1,0,0,"-"],util:[1,0,0,"-"]},"hexonet.apiconnector.connection":{Connection:[1,2,1,""]},"hexonet.apiconnector.connection.Connection":{call:[1,3,1,""],call_raw:[1,3,1,""],call_raw_http:[1,3,1,""]},"hexonet.apiconnector.response":{Response:[1,2,1,""]},"hexonet.apiconnector.response.Response":{as_hash:[1,3,1,""],as_list:[1,3,1,""],as_list_hash:[1,3,1,""],as_string:[1,3,1,""],code:[1,3,1,""],columns:[1,3,1,""],count:[1,3,1,""],description:[1,3,1,""],first:[1,3,1,""],is_success:[1,3,1,""],is_tmp_error:[1,3,1,""],last:[1,3,1,""],lastpagefirst:[1,3,1,""],limit:[1,3,1,""],nextpage:[1,3,1,""],nextpagefirst:[1,3,1,""],page:[1,3,1,""],pages:[1,3,1,""],prevpage:[1,3,1,""],prevpagefirst:[1,3,1,""],properties:[1,3,1,""],property:[1,3,1,""],queuetime:[1,3,1,""],runtime:[1,3,1,""],total:[1,3,1,""]},"hexonet.apiconnector.util":{base64_decode:[1,1,1,""],base64_encode:[1,1,1,""],command_encode:[1,1,1,""],response_to_hash:[1,1,1,""],response_to_list_hash:[1,1,1,""],sqltime:[1,1,1,""],timesql:[1,1,1,""],url_decode:[1,1,1,""],url_encode:[1,1,1,""]},hexonet:{apiconnector:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"01fe1e0":2,"01fe1e0b858690ad95a3e611b9871067af3132b":2,"09997081ddf7c65a6f25fa1827cfb07fd68f82c5":2,"1api":[3,11],"27564296dcd0e0a388ce45b0e77c467e6d927a31":2,"2d98115":2,"2d9811500081c0940e3f340af9265b1c66f36893":2,"400e58b":2,"400e58b5d2c0db4102ad207c65845a537d95aa93":2,"54cd":[3,11],"5642b54":2,"5642b54c25dd3410f699fb54e0f97a4ee1957109":2,"5dc88d4":2,"5dc88d4a85f90a7154d0ccde4df33faff0874591":2,"655b886":2,"655b88658c9c0b1db1be39af8700eb900a19ec87":2,"67430e3":2,"67430e3419237823839b2946c324a93d7d8de22c":2,"85ec52f":2,"85ec52f18007de6a9d37889cd1b20711968749fa":2,"88cedbf":2,"88cedbf82075e19a957349dbc14b2836d99f2117":2,"946bc01":2,"946bc01b7c3505c28400aca50b9d9d4d4de33684":2,"95e0199":2,"95e0199073c19f842778d133ceea8d11a7f64d":2,"9e775a8":2,"9e775a850af227ecfd227b3b838f989daf63edff":2,"break":12,"class":[0,1,3,8],"function":[0,1,8],"import":[2,3,11],"long":10,"new":[4,5,12],"public":5,"return":[1,8],"short":10,"true":1,"try":2,"while":12,AND:10,BUT:10,Being:5,FOR:10,For:10,NOT:10,One:7,Such:12,THE:10,The:[3,4,5,7,8,9,10,11],There:[3,4,6,8,9],These:12,USE:10,Use:[11,12],Using:[3,5],WITH:10,_only_:10,a0f7e2f3418d238f2d4884d786c0d62383d3d0c9:2,a0f7e2f:2,a4bd9606e5590388fac9f96c5621a9e03fd125c6:2,a4bd960:2,a9ec1a1547637535220b33eb86a8172a53634879:2,a9ec1a1:2,aa2bc4d5f92720c22b7853371ade371e1f95b9dd:2,aa2bc4d:2,about:[5,7,8],abov:[10,11],abus:5,accept:5,access:[7,11],accordingli:3,account:[5,11],act:5,action:[5,10],adapt:5,add:2,added:2,adding:10,address:[5,11],advanc:5,advantag:12,age:5,aka:7,align:5,all:[2,5,10,11],allow:[3,11],alreadi:[4,11],also:[2,8,11],analysi:11,ani:[1,5,8,10,12],anoth:11,answer:7,anthoni:10,anyth:12,api:[1,3,8,11],apiconnector:[0,2,3,6,7,9,10,11,12],app:[8,11],appear:5,appli:[5,10],applic:[3,8],appoint:5,appreci:[7,10],appropri:5,aris:10,around:3,arrai:1,as_hash:[1,11],as_list:[1,11],as_list_hash:[1,11],as_str:1,associ:10,assum:11,attack:5,attent:5,attribut:5,author:[4,8],auto:2,automat:9,avail:[3,5,6,8,11],backend:[3,8],background:8,backward:2,ban:5,base64:1,base64_decod:1,base64_encod:1,base:[1,11],basic:[8,10],bd7dc80:2,bd7dc80c9decaccb480333aa4fe51db0c3722389:2,befor:[3,5,7],begin:8,behavior:5,below:10,best:[5,7],better:10,bin:11,binari:1,bit:1,block:11,bodi:[1,5],both:[3,5],bring:7,bug:4,build:5,builtin:8,busi:7,c5601be:2,c5601beb264c7b7e763e88e11aafcc93da310edd:2,c89c917845cda5cef9e4f3a4fb5dc9d022e48006:2,c89c917:2,call:[1,3,11],call_raw:1,call_raw_http:1,can:[3,10,11],care:5,cgi:[3,11],chang:[2,3,5,9,12],changelog:8,charg:[3,10],check:[4,9],circumst:5,claim:10,clarifi:5,clean:1,code:[1,2,3,5,10,11,12],column:1,com:[2,3,10],come:6,command:[1,9,11,12],command_encod:1,comment:[5,10],commit:[2,5],commun:[5,11],compar:2,compat:2,complaint:5,complet:[1,3],compon:8,condit:10,conduct:5,confidenti:5,config:1,configur:[8,11],connect:[1,3,7,10,11],connector:[7,8,9],consid:[3,5],construct:5,contact:[5,8,11],contain:[5,10],contin:[3,6],continu:7,contract:10,contribut:[4,8],contributor:[5,10],conveni:1,convert:1,cookpet:2,copi:10,copyright:10,coreapi:[3,11],correct:5,cost:3,could:[5,11],count:1,coven:5,cover:[3,12],creat:[2,5,11],credenti:3,critic:5,curl:1,current:1,custom:7,d3fa6a:2,d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6:2,damag:10,data:[1,11],date:2,datetim:1,deal:10,debug:8,decod:1,deem:5,defin:[5,11],definit:8,demo:[8,11],depend:[3,5,8],derogatori:5,describ:8,descript:[1,11],design:[1,3,8],detail:[5,8],determin:5,develop:[7,10],did:11,differ:[3,5,7],disabl:5,discuss:5,displai:2,distribut:10,doc:8,document:[2,9,10],doing:[3,5],domain:7,don:[11,12],driven:7,e3042628792eefce6168b93220308b138647c8f0:2,e304262:2,each:8,eager:11,eb2ac4c6458a3620938e429878582e0b1ab93f00:2,eb2ac4c:2,eb5e6d408f088b34172414ed9283fb0fc20e3df3:2,eb5e6d4:2,edit:5,electron:5,element:1,email:5,empathi:5,encod:[1,2],end:5,enforc:5,ensur:5,entiti:[1,3,11],environ:[5,8,9],error:[1,8],etc:[3,5],ethnic:5,evalu:3,event:[5,10],everi:12,everyon:5,exactli:3,exampl:[5,10],exist:12,expect:5,experi:5,expert:7,explicit:5,expos:5,express:[5,10],extend:10,f1804eb7bbb48c6e338f5b065dc935820ddcc595:2,f1804eb:2,fa7403a9b18dc11b9cf8c74da603c12cee01477a:2,fa7403a:2,face:5,fair:5,faith:5,featur:[6,8,12],feel:11,file:[2,4,5,10],filter:11,first:[1,3,4,5,11],fit:10,fix:2,focus:[5,7,8],follow:[3,5,9,10],foreword:8,form:3,format:11,foster:5,found:[1,10],free:[3,5,10,11],from:[3,5,10,12],frontend:3,full:[8,10],furnish:10,further:[5,11],futur:[3,6],gender:5,gener:[2,8,11,12],get:[4,7,8,9,11],github:[2,4,8,10],gitignor:2,give:11,given:1,gmbh:10,goal:7,going:3,golang:7,good:[5,11],got:11,gracefulli:5,grant:10,handl:8,harass:5,hardcod:3,harm:5,hash:1,have:[5,7,11,12],head:11,help:[7,10,11],here:[8,9,11],herebi:10,hexonet:[0,2,3,6,9,10,11,12],hexotestman:3,his:7,holder:10,homepag:[5,7],hopefulli:7,how:[11,12],howev:12,http:[1,2,3,5,7,10,11],hxclient:3,ident:5,ignor:2,imageri:5,implement:10,implementor:7,impli:10,improv:[3,6,12],inappropri:5,incid:5,includ:[5,10],inclus:5,index:1,individu:5,inform:[0,5,8,12],initi:2,insert:5,instal:[5,7,8,11,12],instanc:[1,5,11],instead:2,instruct:8,insult:5,integr:3,interact:5,interest:[5,8],interfac:5,intern:3,internet:7,introduc:2,introduct:11,investig:5,is_success:1,is_tmp_error:1,isharki:10,ispapi:11,issu:[4,5,11],its:5,itself:[10,12],java:7,jira:2,juli:2,just:[3,8],kai:10,kind:[3,10,12],known:[4,7],languag:[5,7],last:1,lastpagefirst:1,latest:9,layer:[1,5],lead:[3,7],leadership:5,legal:8,level:5,liabil:10,liabl:10,librari:[7,8,9,10,11],licens:8,like:[3,5,11,12],limit:[1,10,11],list:[1,4,9,10],live:3,locat:5,logic:3,login:[1,3,11],look:[8,11],made:10,mai:5,mail:[1,5],maintain:5,major:12,make:[1,5,7,12],manag:3,mani:3,media:5,member:5,merchant:10,merg:10,method:[0,5,8,11],might:[3,11],migrat:12,mime:1,minim:8,minor:12,mit:8,mode:3,modifi:10,modul:10,more:7,most:12,mostli:8,much:10,name:7,nation:5,necessari:[5,11],need:[3,11],net:[3,11],newer:8,next:[1,11],nextpag:1,nextpagefirst:1,nice:12,nodej:7,none:[1,3],noninfring:10,notabl:2,note:[5,12],notic:10,now:[3,6,9],number:1,object:1,oblig:5,obtain:10,offens:5,offer:7,offici:5,offlin:5,onc:12,one:[7,8,11],onlin:5,open:5,oper:3,option:[7,11],order:4,org:5,orient:5,origin:10,other:[5,10],otherwis:[5,10],our:[3,4,5,6,7,8],out:[9,10],over:[1,11,12],overflow:4,overview:[8,9],own:12,owner:5,packag:[0,2,8],page:[1,11],papakai:10,paramet:[5,12],part:[1,8,10],particip:5,particular:10,passw0rd:[3,11],password:[1,3,11],patch:[10,12],path:2,peopl:10,pep8:2,perl:7,perman:5,permiss:[5,10],permit:10,person:[5,10],php:7,physic:5,pip3:[9,12],pip:[9,12],plai:3,plan:[3,6,11],pleas:[4,5],pledg:5,polici:5,polit:5,port:5,portion:10,posit:5,possibl:[4,12],post:5,prefer:4,previou:1,prevpag:1,prevpagefirst:1,privat:5,problem:[2,4],process:5,product:[3,7,11],profession:5,profit:12,program:7,project:[2,5,7],properti:[1,2],prose:8,provid:[3,7,10,11,12],publish:[5,10,12],pull:5,purpos:[7,10],py2:2,py3:2,pypi:2,python2:2,python:[2,7,8,10,11,12],qualiti:12,queri:1,querydomainlist:11,question:7,queuetim:1,quickstart:[7,8,9],race:5,read:[4,7,12],readm:[2,5],real:3,realiti:7,realtim:3,reason:[5,11],recommend:9,refactor:2,refer:[8,10],reflect:10,regard:5,regardless:5,registr:3,reject:5,releas:[2,8],religion:5,remoteaddr:11,remov:5,renam:2,repercuss:5,report:5,repositori:5,repres:5,represent:5,request:[5,11],requir:[3,12],respect:5,respons:[1,5,10,11],response_to_hash:1,response_to_list_hash:1,rest:8,restrict:10,result:[1,2,5,11],review:[5,10],rewrit:11,rhash:11,right:[5,10],rlist:11,rlisthash:11,role:[1,3,11],runtim:[1,3],sandbox:3,schneider:10,schwarz:10,scope:5,script:[2,3],sdk:[2,3,6,7,10,11],search:4,section:[8,10,11],see:[10,12],seen:3,sell:10,separ:[3,5],servic:[3,7],session:[3,8],sessionless:11,set:[2,3,5],sever:4,sexual:5,shall:10,ship:10,show:[5,11],sign:11,six:2,size:5,slack:4,small:3,social:5,softwar:[10,12],solut:7,some:[3,7,8,11,12],someth:11,sourc:10,space:5,specif:[0,5,8],specifi:3,sql:1,sqldatetim:1,sqltime:1,stack:4,standard:5,start:[1,7,8,11],step:[5,8],string:1,subfold:2,subject:10,sublicens:10,submodul:0,substanti:10,subus:3,success:1,suffici:3,support:[2,4,7,9],sure:3,surviv:1,system:[3,7,8],take:[5,12],team:[5,7],technolog:7,temporari:5,temporarili:5,ten:7,test:[2,3,11],testrol:3,text:10,thei:[5,9],them:[4,9],thi:[1,2,3,4,5,6,7,8,9,10,11],thing:3,thousand:7,threaten:5,through:[1,7,11,12],thu:10,time:12,timesql:1,timestamp:1,tld:7,tmp:1,toggl:3,tort:10,total:1,touch:4,toward:5,transport:1,troll:5,two:3,unaccept:5,under:10,unittest:10,unix:1,unwelcom:5,updat:[2,5],upgrad:8,upload:2,url:[1,2,3,11],url_decod:1,url_encod:1,use:[2,3,4,5,9,10,11],used:[1,3],useful:5,user:[1,3,11],using:[3,5,9,11],usr:11,usual:3,utc:2,util:1,valu:8,variabl:5,version:[2,5,8],via:[2,5],view:3,viewpoint:5,vscode:2,wai:3,want:[3,10,11],warranti:10,welcom:5,well:[10,11],what:[3,5,8],whatev:10,when:[1,3,5,9],where:12,whether:[7,10],which:[3,5,7,8],who:[5,10],whom:10,wiki:5,wish:5,within:[5,9],without:[5,10],work:11,world:3,worldwid:7,www:11,yet:11,you:[3,5,7,8,10,11,12],your:[3,5,7,9,11,12]},titles:["SDK Documentation","hexonet.apiconnector package","Changelog","Configuration Handling","Contact Us","Contributing","Debugging","Foreword","Welcome to hexonet.apiconnector","Installation","License","Quickstart","Upgrading to Newer Releases"],titleterms:{"return":11,addit:8,api:7,apiconnector:[1,8],applic:11,author:10,backend:[7,11],basic:3,builtin:3,changelog:2,configur:3,contact:4,contribut:5,debug:[3,6],definit:10,depend:9,document:[0,8],environ:3,error:11,featur:3,foreword:7,gener:10,guid:8,handl:3,hexonet:[1,7,8],instal:9,just:11,licens:10,minim:11,mit:10,newer:12,note:8,packag:1,python:9,quickstart:11,releas:12,sdk:[0,8],session:11,submodul:1,system:11,upgrad:12,user:8,valu:3,version:9,welcom:8,what:11}}) \ No newline at end of file +Search.setIndex({docnames:["api","api/hexonet.apiconnector","changelog","config","contactus","contributing","debugging","foreword","index","installation","license","quickstart","upgrading"],envversion:{"sphinx.domains.c":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":1,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:54},filenames:["api.rst","api/hexonet.apiconnector.rst","changelog.rst","config.rst","contactus.rst","contributing.rst","debugging.rst","foreword.rst","index.rst","installation.rst","license.rst","quickstart.rst","upgrading.rst"],objects:{"hexonet.apiconnector":{connect:[1,1,1,""],connection:[1,0,0,"-"],response:[1,0,0,"-"],util:[1,0,0,"-"]},"hexonet.apiconnector.connection":{Connection:[1,2,1,""]},"hexonet.apiconnector.connection.Connection":{call:[1,3,1,""],call_raw:[1,3,1,""],call_raw_http:[1,3,1,""]},"hexonet.apiconnector.response":{Response:[1,2,1,""]},"hexonet.apiconnector.response.Response":{as_hash:[1,3,1,""],as_list:[1,3,1,""],as_list_hash:[1,3,1,""],as_string:[1,3,1,""],code:[1,3,1,""],columns:[1,3,1,""],count:[1,3,1,""],description:[1,3,1,""],first:[1,3,1,""],is_success:[1,3,1,""],is_tmp_error:[1,3,1,""],last:[1,3,1,""],lastpagefirst:[1,3,1,""],limit:[1,3,1,""],nextpage:[1,3,1,""],nextpagefirst:[1,3,1,""],page:[1,3,1,""],pages:[1,3,1,""],prevpage:[1,3,1,""],prevpagefirst:[1,3,1,""],properties:[1,3,1,""],property:[1,3,1,""],queuetime:[1,3,1,""],runtime:[1,3,1,""],total:[1,3,1,""]},"hexonet.apiconnector.util":{base64_decode:[1,1,1,""],base64_encode:[1,1,1,""],command_encode:[1,1,1,""],response_to_hash:[1,1,1,""],response_to_list_hash:[1,1,1,""],sqltime:[1,1,1,""],timesql:[1,1,1,""],url_decode:[1,1,1,""],url_encode:[1,1,1,""]},hexonet:{apiconnector:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"01fe1e0":2,"01fe1e0b858690ad95a3e611b9871067af3132b":2,"09997081ddf7c65a6f25fa1827cfb07fd68f82c5":2,"1api":[3,11],"27564296dcd0e0a388ce45b0e77c467e6d927a31":2,"2d98115":2,"2d9811500081c0940e3f340af9265b1c66f36893":2,"400e58b":2,"400e58b5d2c0db4102ad207c65845a537d95aa93":2,"54cd":[3,11],"5642b54":2,"5642b54c25dd3410f699fb54e0f97a4ee1957109":2,"5dc88d4":2,"5dc88d4a85f90a7154d0ccde4df33faff0874591":2,"655b886":2,"655b88658c9c0b1db1be39af8700eb900a19ec87":2,"67430e3":2,"67430e3419237823839b2946c324a93d7d8de22c":2,"85ec52f":2,"85ec52f18007de6a9d37889cd1b20711968749fa":2,"88cedbf":2,"88cedbf82075e19a957349dbc14b2836d99f2117":2,"946bc01":2,"946bc01b7c3505c28400aca50b9d9d4d4de33684":2,"95e0199":2,"95e0199073c19f842778d133ceea8d11a7f64d":2,"9e775a8":2,"9e775a850af227ecfd227b3b838f989daf63edff":2,"break":12,"class":[0,1,3,8],"function":[0,1,8],"import":[2,3,11],"long":10,"new":[4,5,12],"public":5,"return":[1,8],"short":10,"true":1,"try":2,"while":12,AND:10,BUT:10,Being:5,FOR:10,For:10,NOT:10,One:7,Such:12,THE:10,The:[3,4,5,7,8,9,10,11],There:[3,4,6,8,9],These:12,USE:10,Use:[11,12],Using:[3,5],WITH:10,a0f7e2f3418d238f2d4884d786c0d62383d3d0c9:2,a0f7e2f:2,a4bd9606e5590388fac9f96c5621a9e03fd125c6:2,a4bd960:2,a9ec1a1547637535220b33eb86a8172a53634879:2,a9ec1a1:2,aa2bc4d5f92720c22b7853371ade371e1f95b9dd:2,aa2bc4d:2,about:[5,7,8],abov:[10,11],abus:5,accept:5,access:[7,11],accordingli:3,account:[5,11],act:5,action:[5,10],adapt:5,add:2,added:2,adding:10,address:[5,11],advanc:5,advantag:12,age:5,aka:7,align:5,all:[2,5,10,11],allow:[3,11],alreadi:[4,11],also:[2,8,11],analysi:11,ani:[1,5,8,10,12],anoth:11,answer:7,anthoni:10,anyth:12,api:[1,3,8,11],apiconnector:[0,2,3,6,7,9,10,11,12],app:[8,11],appear:5,appli:[5,10],applic:[3,8],appoint:5,appreci:[7,10],appropri:5,aris:10,around:3,arrai:1,as_hash:[1,11],as_list:[1,11],as_list_hash:[1,11],as_str:1,associ:10,assum:11,attack:5,attent:5,author:[4,8],auto:2,automat:9,avail:[3,5,6,8,11],backend:[3,8],background:8,backward:2,ban:5,base64:1,base64_decod:1,base64_encod:1,base:[1,11],basic:[8,10],bd7dc80:2,bd7dc80c9decaccb480333aa4fe51db0c3722389:2,befor:[3,5,7],begin:8,behavior:5,below:10,best:[5,7],better:10,bin:11,binari:1,bit:1,block:11,bodi:[1,5],both:[3,5],bring:7,bug:4,build:5,builtin:8,busi:7,c5601be:2,c5601beb264c7b7e763e88e11aafcc93da310edd:2,c89c917845cda5cef9e4f3a4fb5dc9d022e48006:2,c89c917:2,call:[1,3,11],call_raw:1,call_raw_http:1,can:[3,10,11],care:5,cgi:[3,11],chang:[2,3,5,9,12],changelog:8,charg:[3,10],check:[4,9],circumst:5,claim:10,clarifi:5,clean:1,code:[1,2,3,8,10,11,12],column:1,com:[2,3],come:6,command:[1,9,11,12],command_encod:1,comment:[5,10],commit:[2,5],commun:[5,11],compat:2,complaint:5,complet:[1,3],compon:8,condit:10,conduct:8,confidenti:5,config:1,configur:[8,11],connect:[1,3,7,10,11],connector:[7,8,9],consid:[3,5],construct:5,contact:[5,8,11],contain:[5,10],contin:[3,6],continu:7,contract:10,contribut:[4,8],contributor:[5,10],conveni:1,convert:1,cookpet:2,copi:10,copyright:10,coreapi:[3,11],correct:5,cost:3,could:[5,11],count:1,coven:5,cover:[3,12],creat:[2,5,11],credenti:3,critic:5,curl:1,current:1,custom:7,d3fa6a:2,d3fa6ae84e8bc0c6ec941964445085b5ea3f3da6:2,damag:10,data:[1,11],date:2,datetim:1,deal:10,debug:8,decod:1,deem:5,defin:[5,11],definit:8,demo:[8,11],depend:[3,5,8],derogatori:5,describ:8,descript:[1,11],design:[1,3,8],detail:[5,8],determin:5,develop:[7,8],did:11,differ:[3,5,7],disabl:5,discuss:5,displai:2,distribut:10,doc:8,document:[2,9,10],doing:[3,5],domain:7,don:[11,12],driven:7,e3042628792eefce6168b93220308b138647c8f0:2,e304262:2,each:8,eager:11,eb2ac4c6458a3620938e429878582e0b1ab93f00:2,eb2ac4c:2,eb5e6d408f088b34172414ed9283fb0fc20e3df3:2,eb5e6d4:2,edit:5,electron:5,element:1,email:5,empathi:5,encod:[1,2],end:5,ensur:5,entiti:[1,3,11],environ:[5,8,9],error:[1,8],etc:[3,5],ethnic:5,evalu:3,event:[5,10],everi:12,everyon:5,exactli:3,exampl:[5,10],exist:12,expect:5,experi:5,expert:7,explicit:5,expos:5,express:[5,10],extend:10,f1804eb7bbb48c6e338f5b065dc935820ddcc595:2,f1804eb:2,fa7403a9b18dc11b9cf8c74da603c12cee01477a:2,fa7403a:2,face:5,fair:5,faith:5,featur:[6,8,12],feel:11,file:[2,4,5,10],filter:11,first:[1,3,4,5,11],fit:10,fix:2,focus:[5,7,8],follow:[3,5,9,10],foreword:8,form:3,format:11,foster:5,found:[1,10],free:[3,5,10,11],from:[3,5,10,12],frontend:3,full:[8,10],furnish:10,further:[5,11],futur:[3,6],gender:5,gener:[2,8,11,12],get:[4,7,8,9,11],github:[2,4,8,10],gitignor:2,give:11,given:1,gmbh:10,goal:7,going:3,golang:7,good:[5,11],got:11,gracefulli:5,grant:10,handl:8,harass:5,hardcod:3,harm:5,hash:1,have:[5,7,11,12],head:11,help:[7,10,11],here:[8,9,11],herebi:10,hexonet:[0,2,3,6,9,11,12],hexotestman:3,his:7,holder:10,homepag:7,hopefulli:7,how:[11,12],howev:12,http:[1,2,3,5,7,11],hxclient:3,ident:5,ignor:2,imageri:5,implement:10,implementor:7,impli:10,improv:[3,6,12],inappropri:5,incid:5,includ:[5,10],inclus:5,index:1,individu:5,inform:[0,5,8,12],initi:2,insert:5,instal:[5,7,8,11,12],instanc:[1,5,11],instead:2,instruct:8,insult:5,integr:3,interact:5,interest:[5,8],interfac:5,intern:3,internet:7,introduc:2,introduct:11,investig:5,is_success:1,is_tmp_error:1,ispapi:11,issu:[4,5,11],its:5,itself:[10,12],java:7,jira:2,juli:2,just:[3,8],kai:10,kind:[3,10,12],known:[4,7],languag:[5,7],last:1,lastpagefirst:1,latest:9,layer:[1,5],lead:[3,7],leadership:5,legal:8,level:5,liabil:10,liabl:10,librari:[7,8,9,10,11],licens:8,like:[3,5,11,12],limit:[1,10,11],list:[1,4,9,10],live:3,locat:5,logic:3,login:[1,3,11],look:[8,11],made:10,mai:5,mail:[1,5],maintain:5,major:12,make:[1,5,7,12],manag:3,mani:3,media:5,member:5,merchant:10,merg:10,method:[0,5,8,11],might:[3,11],migrat:12,mime:1,minim:8,minor:12,mit:8,mode:3,modifi:10,modul:10,more:7,most:12,mostli:8,much:10,name:7,nation:5,necessari:[5,11],need:[3,11],net:[3,11],newer:8,next:[1,11],nextpag:1,nextpagefirst:1,nice:12,nodej:7,none:[1,3],noninfring:10,notabl:2,note:[5,12],notic:10,now:[3,6,9],number:1,object:1,oblig:5,obtain:10,offens:5,offer:7,offici:5,offlin:5,onc:12,one:[7,8,11],onli:10,onlin:5,open:5,oper:3,option:[7,11],order:4,org:5,orient:5,origin:10,other:[5,10],otherwis:[5,10],our:[3,4,6,7,8],out:[9,10],over:[1,11,12],overflow:4,overview:[8,9],own:12,owner:5,packag:[0,2,8],page:[1,11],paramet:[5,12],part:[1,8,10],particip:5,particular:10,passw0rd:[3,11],password:[1,3,11],patch:[10,12],path:2,peopl:10,pep8:2,perl:7,perman:5,permiss:[5,10],permit:10,person:[5,10],php:7,physic:5,pip3:[9,12],pip:[9,12],plai:3,plan:[3,6,11],pleas:[4,5],polici:5,polit:5,port:5,portion:10,posit:5,possibl:[4,12],post:5,prefer:4,previou:1,prevpag:1,prevpagefirst:1,privat:5,problem:[2,4],process:8,product:[3,7,11],profession:5,profit:12,program:7,project:[2,5,7],properti:[1,2],prose:8,provid:[3,7,10,11,12],publish:[5,10,12],pull:8,purpos:[7,10],py2:2,py3:2,pypi:2,python2:2,python:[2,7,8,11,12],qualiti:12,queri:1,querydomainlist:11,question:7,queuetim:1,quickstart:[7,8,9],race:5,read:[4,7,12],readm:[2,5],real:3,realiti:7,realtim:3,reason:[5,11],recommend:9,refactor:2,refer:[8,10],reflect:10,regard:5,regardless:5,registr:3,reject:5,releas:[2,8],religion:5,remoteaddr:11,remov:5,renam:2,repercuss:5,report:5,repositori:5,repres:5,represent:5,request:[8,11],requir:[3,12],respect:5,respons:[1,10,11],response_to_hash:1,response_to_list_hash:1,rest:8,restrict:10,result:[1,2,5,11],review:[5,10],rewrit:11,rhash:11,right:[5,10],rlist:11,rlisthash:11,role:[1,3,11],runtim:[1,3],sandbox:3,schneider:10,schwarz:10,script:[2,3],sdk:[2,3,6,7,11],search:4,section:[8,10,11],see:[10,12],seen:3,sell:10,separ:[3,5],servic:[3,7],session:[3,8],sessionless:11,set:[2,3,5],sever:4,sexual:5,shall:10,ship:10,show:[5,11],sign:11,six:2,size:5,slack:4,small:3,social:5,softwar:[10,12],solut:7,some:[3,7,8,11,12],someth:11,sourc:10,space:5,specif:[0,5,8],specifi:3,sql:1,sqldatetim:1,sqltime:1,stack:4,start:[1,7,8,11],step:[5,8],string:1,subfold:2,subject:10,sublicens:10,submodul:0,substanti:10,subus:3,success:1,suffici:3,support:[2,4,7,9],sure:3,surviv:1,system:[3,7,8],take:[5,12],team:[5,7],technolog:7,temporari:5,temporarili:5,ten:7,test:[2,3,11],testrol:3,text:10,thei:[5,9],them:[4,9],thi:[1,2,3,4,5,6,7,8,9,10,11],thing:3,thousand:7,threaten:5,through:[1,7,11,12],thu:10,time:12,timesql:1,timestamp:1,tld:7,tmp:1,toggl:3,tort:10,total:1,touch:4,toward:5,transport:1,troll:5,two:3,unaccept:5,under:10,unittest:10,unix:1,unwelcom:5,updat:[2,5],upgrad:8,upload:2,url:[1,2,3,11],url_decod:1,url_encod:1,use:[2,3,4,5,9,10,11],used:[1,3],useful:5,user:[1,3,11],using:[3,5,9,11],usr:11,usual:3,utc:2,util:1,valu:8,variabl:5,version:[2,5,8],via:[2,5],view:3,viewpoint:5,vscode:2,wai:3,want:[3,10,11],warranti:10,welcom:5,well:[10,11],what:[3,5,8],whatev:10,when:[1,3,5,9],where:12,whether:[7,10],which:[3,5,7,8],who:[5,10],whom:10,wiki:5,wish:5,within:[5,9],without:[5,10],work:11,world:3,worldwid:7,www:11,yet:11,you:[3,5,7,8,10,11,12],your:[3,5,7,9,11,12]},titles:["SDK Documentation","hexonet.apiconnector package","Changelog","Configuration Handling","Contact Us","Contributing","Debugging","Foreword","Welcome to hexonet.apiconnector","Installation","License","Quickstart","Upgrading to Newer Releases"],titleterms:{"return":11,addit:8,api:7,apiconnector:[1,8],applic:11,attribut:5,author:10,backend:[7,11],basic:3,builtin:3,changelog:2,code:5,conduct:5,configur:3,contact:4,contribut:5,debug:[3,6],definit:10,depend:9,develop:10,document:[0,8],enforc:5,environ:3,error:11,featur:3,foreword:7,gener:10,guid:8,handl:3,hexonet:[1,7,8,10],instal:9,just:11,licens:10,minim:11,mit:10,newer:12,note:8,our:5,packag:1,pledg:5,process:5,pull:5,python:9,quickstart:11,releas:12,request:5,respons:5,scope:5,sdk:[0,8],session:11,standard:5,submodul:1,system:11,upgrad:12,user:8,valu:3,version:9,welcom:8,what:11}}) \ No newline at end of file diff --git a/docs/_build/html/upgrading.html b/docs/_build/html/upgrading.html index 5b0425a..3d480ab 100644 --- a/docs/_build/html/upgrading.html +++ b/docs/_build/html/upgrading.html @@ -78,7 +78,9 @@

    Table Of Contents

  • Upgrading to Newer Releases
  • Changelog
  • License
    • +
  • HEXONET Developers
  • Contributing
    • +
  • Contributing
  • Contact Us
    • diff --git a/docs/changelog.rst b/docs/changelog.rst index 2317c2d..77dd904 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,4 +1,4 @@ Changelog ========= -.. include:: ../HISTORY.md +.. mdinclude:: ../HISTORY.md diff --git a/docs/conf.py b/docs/conf.py index 0dc73c0..6a1ec75 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,11 +18,12 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', - 'sphinxcontrib.log_cabinet' + 'sphinxcontrib.log_cabinet', + 'm2r' ] exclude_patterns = ['_build', '/docs/api/*.rst'] -source_suffix = ['.rst'] +source_suffix = ['.rst', '.md'] intersphinx_mapping = {} diff --git a/docs/contributing.rst b/docs/contributing.rst index 1460c24..21261e9 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -3,4 +3,4 @@ Contributing ============ -.. include:: ../CONTRIBUTING.md +.. mdinclude:: ../CONTRIBUTING.md diff --git a/docs/license.rst b/docs/license.rst index 3fa7a01..35f3776 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -13,7 +13,7 @@ The full license text can be found below (:ref:`mit-license`). Authors ------- -.. include:: ../AUTHORS.md +.. mdinclude:: ../AUTHORS.md General License Definitions --------------------------- diff --git a/src/m2r b/src/m2r new file mode 160000 index 0000000..01f6251 --- /dev/null +++ b/src/m2r @@ -0,0 +1 @@ +Subproject commit 01f6251669ed3b587effeda6304ff77727b7bac4