astronomy-commons / astronomy-commons/lsdb

Consider myst for doc rendering

Open
#396 2 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
55
Forks
26
Avg merge
4d 1h
Merged PRs (30d)
8

Description

@bsipocz has had success with using myst, in combination with sphinx, for readthedocs rendering.

This would enable notebooks to be source-controlled as markdown files, instead of hard-to-read ipynb.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the current Sphinx and Read the Docs rendering setup, then assess how Myst would handle the project's notebooks. Confirm whether notebooks can be source-controlled as readable Markdown files and rendered successfully through the documentation build; done means the proposed workflow works without relying on hard-to-read ipynb sources.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.