Add JS docs for Sphinx documentation #331
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We use ``sphinx-js`` to add support for JSDoc markup to sphinx. In order
to actually run the JSDoc parser we also add ``ǹodeenv`` to the project
to create convenient node virtual envs in which we can install
``jsdoc``.
Note:
This commit does include any documentation itself but just the
machinery.
Ref.: #254
This commit adds the autogenerated jsdoc output to our sphinx documentation. Its main purpose is to serve as a proof of concept for the new jsdoc-sphinx setup. As part of this, the jsdoc markup within ``stuff.js`` had to be fixed as the previous version was invalid. Ref.: #257
|
I can't finish this, I find it a bit over the top to need Since this is largely an abandoned PR and we are trying to sort out the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #254