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.

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

Update docs and remove scenarios.yaml #241

Merged
merged 11 commits into from
Jun 16, 2023
Merged

Conversation

brynpickering
Copy link
Member

@brynpickering brynpickering commented May 18, 2022

Fixes #230 & #236. Reverts #209.

Since we are now modular, it's impossible to have any one file that links to the contents of multiple other files (as scenarios.yaml was doing in grouping overrides). So, we have to remove this file and instead document how one would create their own scenarios by grouping overrides.

Checklist

Any checks which are not relevant to the PR can be pre-checked by the PR creator. All others should be checked by the reviewer. You can add extra checklist items here if required by the PR.

  • CHANGELOG updated
  • Minimal workflow tests pass
  • Tests added to cover contribution
  • Documentation updated
  • Configuration schema updated

@timtroendle
Copy link
Member

@brynpickering is this ready to be reviewed again?

@brynpickering
Copy link
Member Author

Yes!

Copy link
Member

@timtroendle timtroendle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it now!

One small thing needs to be fixed: all code boxes (yaml and python) in the overrides section of customisation.md are broken (have a look at the readthedocs preview). Not sure what's going on but it's basically unreadable right now.

@brynpickering
Copy link
Member Author

Hmm, the code blocks render just fine when I build it locally:

image

@timtroendle
Copy link
Member

It works for me too. Also, I figured just now, that these code blocks are broken in other parts of the documentation on readthedocs, too. That's weird. Is it possible that this is a glitch in the built?

@brynpickering
Copy link
Member Author

I checked the supposed dead markdown link (https://open-power-system-data.org/) and it isn't dead.

Copy link
Member

@timtroendle timtroendle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for following up on this, @brynpickering . It all looks good to me now, apart from the erratic behaviour of the Markdown link check. We need to investigate what's going on or otherwise remove it. It's suspicious that it's consistently open-power-system-data that's failing.

@timtroendle timtroendle merged commit 57e67af into develop Jun 16, 2023
@timtroendle timtroendle deleted the fix-scenario-denfinitions branch June 16, 2023 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Imports aren't properly documented
2 participants