KaTeX for documentation

Open
#598 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the linked hmmm 0.1.1 documentation on docs.rs and compare its KaTeX rendering with ndarray's documentation. Determine whether better-rendered mathematics is feasible and define what documentation changes would be needed; done means an agreed approach and a clear implementation scope.

Written by the indexing model from the issue text.

Description

docs enhancement

A new crate, hmmm, has just been released.
It's a super cool project, dealing with Hidden Markov Model Models, but the relevant piece for ndarray is its documentation: @paulkernfeld managed to get KaTeX to work on doc.rs ❤️

Is this something we might be interested in doing? I'd personally love to have better rendered math than ASCII art 😅

Dominant language
Rust
Stars
4.3k
Forks
391
No merged PRs in 30d

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.

More from rust-ndarray/ndarray

All issues in rust-ndarray/ndarray

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.