EnergySystemsModellingLab / EnergySystemsModellingLab/muse2_data_analysis

Set up initial documentation

Aperta
#4 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation question
Lingua principale
Python
Stelle
0
Fork
0
Merge medio
17h 5m
PR unite (30g)
11

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.