pyodide / pyodide/sphinx-js

Support automodule for JavaScript

Open
#293 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
290
Forks
80
PR merge metrics
No merged PRs in 30d

Description

First of all, thanks for this great package. I find it very useful.

I was trying to use .. automodule directive for JavaScript modules, but kept getting assertion error. After a very brief look at the source code I understand that .. automodule only works for TypeScript.

  • Is my assumption correct or am I getting it all wrong?
  • Is there an intention to implement automodule and maybe even autosummary for JS?

Thanks )

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing automodule implementation and the assertion that currently limits it to TypeScript. Determine the intended JavaScript module behavior and whether autosummary is also in scope; done means a settled implementation direction with coverage for the requested JavaScript support.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.