Markdown in doc comments
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 290
- Forks
- 80
- PR merge metrics
- No merged PRs in 30d
Description
JSDoc can interpret doc comments as Markdown. I'm using this for formatting and cleaner links. But I guess it outputs HTML, so when used with sphinx-js you end up with HTML tags in your docs.
class MissingValueError()
<p>Required value missing error.</p> <p>Thrown when an operation requires a value that is not available.</p>
MissingValueError.name
<p>Error type name.</p>
Is there any way to use Markdown with sphinx-js?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name files, tests, or entry points. Start by tracing how sphinx-js processes JSDoc comments and how that output is passed to Sphinx; the work is done when Markdown formatting is supported without unwanted HTML tags in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100