Skip to content

Commit

Permalink
Expand readme with jsdoc related information
Browse files Browse the repository at this point in the history
Ref.: #254
  • Loading branch information
elbenfreund committed Apr 9, 2018
1 parent 1a255ad commit fb9ac92
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,17 @@ it::
Now you are all setup to run ``make develop`` and related make targets without
changing you main environment.

The following is only needed if you wish to build the documentation.

After you ran ``make develop``, create a new *node virtual env* with (the freshly installed)
``nodeenv``::

nodeenv .nodeenv
source .nodeenv/bin/activate

Finally use npm to setup jsdoc in your virtual node environment::
npm install -g jsdoc

Manual Installation For Testing and Development
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Clone the repository::
Expand Down

0 comments on commit fb9ac92

Please sign in to comment.