Skip to content

API docs: include multiple versions: master, latest & past releases #100

@HannoSpreeuw

Description

@HannoSpreeuw
  • Configure Sphinx
  • add API docs
  • deploy to RTD/GH pages
  • Include a list of all configurable variables, i.e. everything that can be included in a config.toml.
  • Make sure that the descriptions of those variables, such as these, are also rendered.
  • Indicate clearly which variables will have an effect only for the command line, such as rmsmap; setting this to True has no effect unless the cli is used. residuals and islands, on the other hand, should also be effectuated when not using the cli, since they are propagated here and here, respectively.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions