python sphinx - Documentation for multi-programming-language API -


i'm part of team working on sdk exposed several programming languages - objc, c#, actionscript, java (android) , later we'll have more languages.

we want have documentation made of 2 parts:

  1. human readable documentation
  2. api reference

there links between 2 parts: human readable docs have links specific classes or methods , api reference may link document explain context in class or method used.

we use combination of sphinx human readable documentation , language specific tools api such doxygen or asdoc

i saw in leapmotion able generate complete documentation multiple programming-language (not human language) cross links between programming-languages.

the question

does know how accomplish such documentation system in way we'll not have duplicate each change in human readable docs every language , have cross links between languages?

i put leap motion documentation. use sphinx create package of docs , breathe, sphinx plug-in, import xml files generated doxygen sphinx project doxygenated api references (c++, c#, java, , objective-c). links so-called "human-readable" pages api references, generate rst substitutions .tag files doxygen generate you. links api reference "human-readable" pages normal, relative hyperlinks (which should add more of).

i use conditional content features of sphinx generate separate set of docs (both "human-readable" , api) each programming language. these articles can customized each programming language needed , have correct code examples current language. because each doc set has same structure, isn't hard switch 1 language another.

i did add custom javascript page templates switch between languages.

tl;dr: sphinx, breathe, doxygen , small amount of custom javascript.

if discuss further, can post question our (leap motion) developer forum. i'll see (stackoverflow isn't proper place ongoing discussion).


Comments

Post a Comment

Popular posts from this blog

javascript - Jquery show_hide, what to add in order to make the page scroll to the bottom of the hidden field once button is clicked -

i have button on website when clicked, reveals map. button can seen when page first loads up, when clicked, section holding map slides open , goes out of screen since page loads @ top (normal). want page scroll down bottom of div select when button pushed, if map out of screen. if page scrolled down, , clicks show map button, don't want page jump bottom of map. i tried figure out myself, no luck. seasoned jquery coders able give me guidance? many thanks! map = mapdiv.gmap3("get"); infobox = new infobox({ pixeloffset: new google.maps.size(-220, -310), closeboxurl: '', enableeventpropagation: true }); mapdiv.delegate('.infobox .close','click',function () { infobox.close(); }); jquery(".slidingdiv").hide(); jquery(".show_hide").show(); jquery('.show_hide').click(function(){ lastcenter=map.getcenter(); jquery(".slidingdiv...
Read more

python - Django-cities exits with "killed" -

i trying install django-cities on server 500mb ram. whenever run: manage.py cities the system exits saying killed. trying run: manage.py cities --import=country --force worked, guessing matter of running out of memory. to bypass, tried refer package local copy of cities' data file. still didn't work. any ideas on how can migrate data without having increase memory on server? based on suggestion comments, solved setting temporary swap file. if unfamiliar it, can follow these steps: set swap file touch /var/swap.img chmod 600 /var/swap.img set swap file size cd /var dd if=/dev/zero of=/var/swap.img bs=1024k count=1000 this create 1gb swap file. prepare disk image mkswap /var/swap.img activate swap memory swapon /var/swap.img once done, can turn off swap image: swapoff /var/swap.img more information on virtual memory , swap files can found here: https://www.digitalocean.com/community/tutorials/how-to-configure-virtual-me...
Read more

python - How to get a widget position inside it's layout in Kivy? -

i have gridlayout , added image widgets on after adding of images want draw rectangle in each image using canvas couldn't because don't know exact image widgets positions on gridlayout. code: http://paste.ofcode.org/3bdp9yhjrcrzmsztbu9hqp4 http://paste.ofcode.org/3az3gx4fxzr9dlhe2ami97c in last line of python code : rectangle(pos = (child.x - 2.4, child.y + 467), size = (70, 70)) how draw rectangle in child(my method not good^), also why gridlayout not coming in center after setting it's pos_hint = {"center_x" : .5}? if understand question right, try use such methods to_local() , to_parent() , to_widget() , to_window() . try substract position of gridlayout widgets' positions.
Read more