Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reduce Parameter API #121

Merged
merged 8 commits into from
Jan 24, 2018
Merged

Reduce Parameter API #121

merged 8 commits into from
Jan 24, 2018

Commits on Jan 24, 2018

  1. Reduce Parameter API 

    - expose ParameterList and Narrative directly on smif.parameters
- move implementation to hidden submodules
- create Parameter class to hold individual parameter metadata

Intended to reduce the API size and be more explicit about data
required (replacing plain dicts with data object).
    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    bb99daf View commit details
    Browse the repository at this point in the history

  2. Don't hide parameters submodules

    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    b35007e View commit details
    Browse the repository at this point in the history

  3. Maintain order when adding Parameters to ParameterList

    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    e86c468 View commit details
    Browse the repository at this point in the history

  4. Use better-apidoc to template module reference docs 

    - gives finer control over auto-generated docs
- requires better-apidoc package, added to test-requirements
    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    d8f99f1 View commit details
    Browse the repository at this point in the history

  5. Include better-apidoc (hence also sphinx and deps) in .environment.ym… 

    …l for ReadTheDocs
    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    60c5b47 View commit details
    Browse the repository at this point in the history

  6. Remove README import from docs

    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    69656b6 View commit details
    Browse the repository at this point in the history

  7. Add badges to docs index page

    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    3d7eadc View commit details
    Browse the repository at this point in the history

  8. Include written-in-python and funding info in docs intro

    @tomalrussell
    tomalrussell committed Jan 24, 2018
    Configuration menu
    Copy the full SHA
    564eca6 View commit details
    Browse the repository at this point in the history