sphinx-doc/sphinx

Javascript domain :js:module:: [name] does not produce an entry in the module index

Open

#5,517 opened on Oct 8, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
awaiting:responsedomains:jshelp wanted

Description

Problem

A .. :js:module:: [any module name] does not produce a module entry in the module index. But the documentation says it would make an entry. If you don't use :py:module:: no modindex.html will be generated. The :synopsis option is not supported.

Environment info

  • OS: Debian Stretch
  • Python 2.7 and 3:
  • Sphinx version: 1.8.1

Contributor guide

Tech stack
pythonjavascript
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python development environmentSphinx source code checkoutFamiliarity with Sphinx domains
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the JavaScript domain module in Sphinx, likely in sphinx/domains/javascript.py. Compare the implementation of :js:module: with :py:module: to see how the Python domain adds entries to the module index. Also check if the synopsis option is properly handled. Consider reviewing the module index generation logic in sphinx/builders/html/ init .py.