documentation - Continuous user manual generation -

-

are there solutions existing "continuous documentation", e.g. documentation markup languages , build plugins jenkins/hudson?

i'm not talking generating api description, user manuals screenshots, etc. keeping user manual up-to-date tedious job, thought idea write user manual in markup (xml) , have transformed html , pdf during build process.

this quite straightforward implement, wondering if there solutions or best practices existing, e.g. sphinx, maybe in javas i'm not allowed use python.

unfortunately there not many choices in pure java world:

  • for simple manuals use markdown , java implementation f.ex. pegdown; works simple html manuals pdf generation difficult.
  • if have sphinx-documentation use restructuredtext-java implementation jrst (not powerfull sphinx) or run sphinx jpython...

  • the best solution in opinion write document in asciidoc. since few weeks there exists a java-wrapper (which use jruby) ruby port named asciidoctor.

    the asciidoc language powerful , it's easy produce docbook asciidoc. docbook there exists lot (sometimes hidden...) java-tools.


Comments

Post a Comment

Popular posts from this blog

java - Jmockit String final length method mocking Issue -

-
using jmockit 1.2 jar, trying mock string's length method getting unexpected invocation exception: failed: test java.lang.illegalstateexception: missing invocation mocked type @ point; please make sure such invocations appear after declaration of suitable mock field or parameter @ stringdemo.testa$1.<init>(testa.java:17) @ stringdemo.testa.test(testa.java:13) i using testng: @test public void test() throws exception { new expectations() { @mocked("length") string astring; { astring.length(); result = 2; } }; system.out.println(a.showa("test")); } } actual class a: public class { public static int showa(string str){ int a= str.length(); return a; } } this wrong way of recording expected results. shouldn't mock , record string's length() method, record showa() instead. here solution @suppresswarnings("unused&qu
Read more

asp.net - Razor Page Hosted on IIS 6 Fails Every Morning -

-
i have simple page in intranet uses razor/asp fetch single record table , display it, plus few graphic, dashboard display. meaning, no user intervention other first time open ie internal url. the problem having every morning ie displays "page not found or network error" message. refresh page, , it's stuck , doesn't display anything. try different pc, open ie internal url , it's stuck... ...until following: login server hosting page run inetmgr go web sites, etc right click on page that's giving me problem , select browse at moment, error message: server error in '/' application. -------------------------------------------------------------------------------- type of page not served. description: type of page have requested not served because has been explicitly forbidden. extension '.cshtml' may incorrect. please review url below , make sure spelled correctly. requested url: /application/dashboard.cshtml ---------------
Read more

c++ - wxwidget compiling on windows command prompt -

-
can please guide me on method,as how compile wxwidget using windows command prompt or msys. [i can't seem find on wxwiki/wxwidget official book/anywhere else] i have compiled wxwidget instructions have provided (using msys). from searching on internet seems 1 can (maybe?) through use of makefile (is correct?) if yes: directory & how should link wx libraries in makefile if no: way besides makefile? i know can use ide's code::block , make life simpler prefer compile using command prompt/msys. thanks in advance.
Read more