Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

integrate JSDoc docstrings into sphinx docs #254

Open
elbenfreund opened this issue Apr 9, 2018 · 1 comment
Open

integrate JSDoc docstrings into sphinx docs #254

elbenfreund opened this issue Apr 9, 2018 · 1 comment
Assignees
@elbenfreund
Labels
Packaging/Meta Issues and Bugs not related to the code itself but its packaging.
Milestone
0.11.0

Comments

@elbenfreund
Copy link
Contributor

While the code itself is (partially) documented using JSDoc syntax, our acutal sphinx documentation does not support nor use this. This should be fixed.
@elbenfreund elbenfreund added the Packaging/Meta Issues and Bugs not related to the code itself but its packaging. label Apr 9, 2018
@elbenfreund elbenfreund added this to the 0.10.0 milestone Apr 9, 2018
@elbenfreund elbenfreund self-assigned this Apr 9, 2018
@elbenfreund elbenfreund modified the milestones: 0.10.0, 0.11.0 Apr 10, 2018
@elbenfreund
Copy link
Contributor Author

Our current way to define classes (using imports.Lang features) is not really compatible with JSDocs automated extraction of class methods/properties. Instead of working around this, this issue will be postponed to 0.11.0 when #257 will refactor the way classes are defined in such a way that should play nice with JSDoc/autodoc.

elbenfreund added a commit that referenced this issue Apr 10, 2018
@elbenfreund
Add JSDoc support to sphinx setup
1a255ad 
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
elbenfreund added a commit that referenced this issue Apr 10, 2018
@elbenfreund
Expand readme with jsdoc related information
fb9ac92 
Ref.: #254
@benjaoming benjaoming mentioned this issue Apr 29, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@elbenfreund elbenfreund

Labels
Packaging/Meta Issues and Bugs not related to the code itself but its packaging.
Projects
None yet
Milestone
0.11.0
Development

Successfully merging a pull request may close this issue.

Add JS docs for Sphinx documentation projecthamster/hamster-shell-extension
1 participant
@elbenfreund