Jump to content

My new documentation library - tests


Recommended Posts

Hello guys,


I've made new documentation generator for javascript (it can be used with any langauge though) and I would like to share it with you and get some feedback.

It's an early version, so it can have some bugs, but it works. 


I did make it because I didn't like JSDoc3. JScribe has (imho) important features that JSDoc doesn't, in example you can create your own tags, like: factory, prototype, object etc. and JScribe will automatically create list of those elements for you.


Library is wrote in Python. You can download it from here: https://pypi.python.org/pypi/JScribe/

Documentation (made using JScribe, but still sparse, oh the irony): http://mindbrave.com/jscribe/docs/

Github rep: https://github.com/mindbrave/jscribe


To use it you need Python2.7, if you happen to use linux/unix then you should have Python installed by default. Then just unpack it and run 

`python jscribeit.py path/to/your/settings.json` - documentation covers that.


I didn't test it on windows yet.

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Create New...