Code

Update documentation#460

Code

Merged

FlorianK13 merged 74 commits intodevelopOpenEnergyPlatform/open-MaStR:developfrom feature-434-documentationOpenEnergyPlatform/open-MaStR:feature-434-documentationCopy head branch name to clipboardNov 20, 2023

+1,023-1,670

Commits

Commits on Jul 24, 2023

• Include pypistats link in Readme #434

  FlorianK13

  authored
  a0d5358

  Copy full SHA for a0d5358

Commits on Jul 28, 2023

• Upgrade to python 3.10 #434

  FlorianK13

  committed
  7ab90b7

  Copy full SHA for 7ab90b7

• Add mkdocs dependencies #434

  FlorianK13

  committed
  f5b966e

  Copy full SHA for f5b966e

• Add linting config for ruff linter

  FlorianK13

  committed
  ca53a9c

  Copy full SHA for ca53a9c

• Initial commit for mkdocs documentation page #434

  FlorianK13

  committed
  3105fd2

  Copy full SHA for 3105fd2

• Change docstrings to be .md conform #434

  FlorianK13

  committed
  1dd4959

  Copy full SHA for 1dd4959

Commits on Aug 7, 2023

• Add a watch for automatic docstring update #434

  FlorianK13

  committed
  aadc754

  Copy full SHA for aadc754

• Update docstrings to be mkdocs conform #434

  FlorianK13

  committed
  892f2e6

  Copy full SHA for 892f2e6

• Include links to other package functions #434

  FlorianK13

  committed
  e077a35

  Copy full SHA for e077a35

• Add default options for mkdocstrings #434

  FlorianK13

  committed
  7a8c7da

  Copy full SHA for 7a8c7da

• Split references in advanced and basic #434

  FlorianK13

  committed
  98f2a18

  Copy full SHA for 98f2a18

• Update README.rst

  Show description for ab2062e
  chrwm

  committed
  ab2062e

  Copy full SHA for ab2062e

• Integrate toc into navigation #434

  chrwm

  committed
  cf82453

  Copy full SHA for cf82453

Commits on Aug 9, 2023

• Initial dataset description #434

  FlorianK13

  committed
  b43f030

  Copy full SHA for b43f030

• Update the naviation #434

  FlorianK13

  committed
  0075ef7

  Copy full SHA for 0075ef7

• Extend starting page #434

  FlorianK13

  committed
  fd5b250

  Copy full SHA for fd5b250

• Make MaStRAPI docstring markdown conform #434

  FlorianK13

  committed
  f983f21

  Copy full SHA for f983f21

• Make MaStRDownload docstrings mkdocs conform #434

  FlorianK13

  committed
  63b8b27

  Copy full SHA for 63b8b27

• Clarify content of subchapter #434

  FlorianK13

  committed
  685685b

  Copy full SHA for 685685b

• Add configuration chapter #434

  FlorianK13

  committed
  a9db5a1

  Copy full SHA for a9db5a1

• Delete unnecessary handler #434

  FlorianK13

  committed
  7a353ab

  Copy full SHA for 7a353ab

Commits on Aug 10, 2023

• Make MaStRMirror docstrings markdown conform #434

  FlorianK13

  committed
  3bd4595

  Copy full SHA for 3bd4595

• Add advanced documentation pages #434

  FlorianK13

  committed
  b5fc4e4

  Copy full SHA for b5fc4e4

• Use RLI super repo theme #434

  FlorianK13

  committed
  1b7727a

  Copy full SHA for 1b7727a

• Add data model picture in english #434

  FlorianK13

  committed
  a0d05fb

  Copy full SHA for a0d05fb

• Update Zenodo link #434

  chrwm

  committed
  b9cf0f1

  Copy full SHA for b9cf0f1

Commits on Aug 14, 2023

• Adjust/add sections #434

  chrwm

  committed
  480f842

  Copy full SHA for 480f842

• Add css-based TOC blur/highlighting #434

  Show description for 438772e
  chrwm

  committed
  438772e

  Copy full SHA for 438772e

• Separate data and software publication #434

  chrwm

  committed
  2897b29

  Copy full SHA for 2897b29

• Add logo and favicon #434

  chrwm

  committed
  bd2d634

  Copy full SHA for bd2d634

Commits on Aug 15, 2023

• Add markdown extension to enable the usage of content tabs #434

  

  Oskar.Oetken

  committed
  0accee6

  Copy full SHA for 0accee6

• Create welcome file for Advanced tab #434

  

  Oskar.Oetken

  committed
  ce32b87

  Copy full SHA for ce32b87

• Add welcome file into the Advanced tab #434

  

  Oskar.Oetken

  committed
  ecff56d

  Copy full SHA for ecff56d

Commits on Aug 16, 2023

• Move bulk trade-offs into admonition #434

  chrwm

  committed
  d7bdb9d

  Copy full SHA for d7bdb9d

• Update zenodo link in README #434

  FlorianK13

  committed
  29c02c6

  Copy full SHA for 29c02c6

Commits on Aug 17, 2023

• Add contributions section #434

  chrwm

  committed
  e948edf

  Copy full SHA for e948edf

• Add db background info in Q&A style #434

  Show description for 090d4aa
  chrwm

  committed
  090d4aa

  Copy full SHA for 090d4aa

• Change to grey favicon #434

  FlorianK13

  committed
  8e6cc94

  Copy full SHA for 8e6cc94

• Add automated release notes from github #458

  FlorianK13

  committed
  fe5d58a

  Copy full SHA for fe5d58a

• Define docs build dependencies #434

  Show description for 30841fd
  FlorianK13

  committed
  30841fd

  Copy full SHA for 30841fd

• Switch dependencies from sphinx to mkdocs #434

  FlorianK13

  committed
  da413d0

  Copy full SHA for da413d0

Commits on Aug 21, 2023

• Change readthedocs to use mkdocs #434

  FlorianK13

  committed
  c6239e6

  Copy full SHA for c6239e6

• Repair link to file #434

  FlorianK13

  committed
  bb2d470

  Copy full SHA for bb2d470

• Delete unused mkdocstring option #434

  FlorianK13

  committed
  fe8bb7e

  Copy full SHA for fe8bb7e

• Repair cross-ref links #434

  FlorianK13

  committed
  ef69002

  Copy full SHA for ef69002

• Merge branch 'develop' into feature-434-documentation

  FlorianK13

  authored
  6180b0e

  Copy full SHA for 6180b0e

Commits on Aug 23, 2023

• Add total number of Downloads #434

  FlorianK13

  authored
  a8e0a6e

  Copy full SHA for a8e0a6e

Commits on Aug 29, 2023

• Make advance welcome screen empty

  chrwm

  committed
  4553090

  Copy full SHA for 4553090

• Add mike #434

  Show description for 883fe17
  chrwm

  committed
  883fe17

  Copy full SHA for 883fe17

• Add mike to dev requierements #434

  chrwm

  committed
  8f0efaa

  Copy full SHA for 8f0efaa

• Delete outdated tables.xml info #434

  chrwm

  committed
  5f43c27

  Copy full SHA for 5f43c27

• Update configuration.md #434

  chrwm

  committed
  d1c9d09

  Copy full SHA for d1c9d09

• Update configuration.md #434

  chrwm

  committed
  5298db0

  Copy full SHA for 5298db0

Commits on Aug 30, 2023

• Put all advanced doc in advanced.md #434

  FlorianK13

  committed
  cb20d2c

  Copy full SHA for cb20d2c

• Repair headings in advanced #434

  FlorianK13

  committed
  e136e87

  Copy full SHA for e136e87

• Add mermaid diagram of bulk download process #434

  FlorianK13

  committed
  e7154ee

  Copy full SHA for e7154ee

• Add DB Browser screenshot #434

  FlorianK13

  committed
  44aee50

  Copy full SHA for 44aee50

• Put data tables in tabs #434

  FlorianK13

  committed
  0ac99e6

  Copy full SHA for 0ac99e6

Commits on Sep 25, 2023

• Merge contribution table into text #434

  chrwm

  committed
  ed5c396

  Copy full SHA for ed5c396

• Add high level MaStRAPI description #434

  chrwm

  committed
  25d5712

  Copy full SHA for 25d5712

Commits on Sep 26, 2023

• Add high level MastrDownload description #434

  chrwm

  committed
  7193e22

  Copy full SHA for 7193e22

• Add high level MaStRMirror description #434

  chrwm

  committed
  9ec0a0b

  Copy full SHA for 9ec0a0b

• Add first part of high level csv description #434

  chrwm

  committed
  8ebeb2a

  Copy full SHA for 8ebeb2a

• Update project directory #434

  chrwm

  committed
  425083f

  Copy full SHA for 425083f

Commits on Sep 27, 2023

• Merge branch 'develop' into feature-434-documentation

  FlorianK13

  authored
  31881bc

  Copy full SHA for 31881bc

• Uncomment create_additional_data_requests

  Show description for 559066d
  FlorianK13

  committed
  559066d

  Copy full SHA for 559066d

• Delete unused rst files #434

  FlorianK13

  committed
  7101a12

  Copy full SHA for 7101a12

• Repair reference links #434

  FlorianK13

  committed
  5526613

  Copy full SHA for 5526613

• Run spell and grammar checker #434

  Show description for eb8cda0
  FlorianK13

  committed
  eb8cda0

  Copy full SHA for eb8cda0

Commits on Nov 3, 2023

• Merge develop into documentation branch #434

  FlorianK13

  committed
  6e560aa

  Copy full SHA for 6e560aa

• Update Readme Documentation section #434

  FlorianK13

  committed
  29a661d

  Copy full SHA for 29a661d

• Formulate API usage more precisely #434

  FlorianK13

  committed
  a13f12f

  Copy full SHA for a13f12f

Commits on Nov 20, 2023

• Delete ruff.toml #434

  FlorianK13

  committed
  2ad18cf

  Copy full SHA for 2ad18cf

• Update changelog #434

  FlorianK13

  committed
  f92da11

  Copy full SHA for f92da11