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&quo
Read more

javascript - Highcharts multi-color line -

Image
i looking create highchart multi-colored line. if goes down under value, become red, , when comes on value, become green . here picture example: or maybe highcharts have other charts models differentiate high or low level color? you can achieve coloring using lineargradient coloring: color: { lineargradient: { x1: 0, x2: 0, y1: 0, y2: 1 }, stops: [ [0, 'red'], [0.25, 'yellow'], [0.50, 'green'], [0.75, 'yellow'], [1, 'red'] ] } here 0 in stops relates minimum value of series , 1 maximum value, , in between percentages between values. if find percentages according values prior creating chart use correct stops values make relate specific values in data (at least approximately). see this jsfiddle example .
Read more

javascript - Enter key does not work in search box -

tried search guys sorry. input in search box doesnt work (or search) when hit enter when user clicks search button. doing wrong? here code. thanks. <script type="text/javascript"> $(document).ready(function() { $("#submit").click(function() { var url = "http://asla.org/awardssearch.html"; url += "?s=" + $('#googlecse').val(); window.location = url; }); $('#googlecse').keydown(function(event) { if (event.keycode == '13') { $("#submit").click(); } else { //do nothing :) } }); }); </script> <form class="navbar-form navbar-right" role="search"> <div class="search"> <input id="googlecse" type="text" onblur="if(this.value=='')this.value=this.defaultvalue;" onfocus="if(this.value==this.defaultvalue)t
Read more