EnergySystemsModellingLab / EnergySystemsModellingLab/muse2_data_analysis

Set up initial documentation

未關閉
#4 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
documentation question
主要語言
Python
星號
0
分支
0
平均合併
17 小時 5 分鐘
30 天內合併 PR
11

描述

At some point, we will probably want the code and notebooks in this repo to have documentation on GitHub Pages.

We will need to work out a few things before we do that, namely:

1. What do we want this repo to be for? Are we going to publish a Python package or is it just example Jupyter notebooks etc.?
2. How are we going to divide the documentation between this repo and the main one? Where should tutorials live?
3. What tooling do we want to use for this? MkDocs is the obvious choice (there is also [a plugin for notebooks](https://github.com/danielfrg/mkdocs-jupyter)), but we could also go with mdBook, as we've done for the main repo, for consistency.

My feeling about 2 is that it probably makes sense to have tutorials in **this** repository, as we will want to walk users through analysing the data, which will be easier if we embed Jupyter notebooks.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

首先解決 issue 中的三個問題:repository 的用途、文件和教學應如何劃分,以及使用 MkDocs 還是 mdBook。issue 中沒有指定任何檔案或測試。確定文件範圍、教學位置和 GitHub Pages 工具後,即視為完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
jupyter-notebook, python
領域
documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
20/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。