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

Fix displaying the options wildcard in read-the-docs #932

Merged
merged 1 commit into from
Dec 9, 2023

Conversation

ekatef
Copy link
Collaborator

@ekatef ekatef commented Dec 3, 2023

Currently, the configtable for options is not displayed in our documantation due to parsing errors:

https://pypsa-earth.readthedocs.io/en/latest/wildcards.html#the-opts-wildcard

Changes proposed in this Pull Request

Fixed format of opts.csv configtable.

Checklist

  • I consent to the release of this PR's code under the AGPLv3 license and non-code contributions under CC0-1.0 and CC-BY-4.0.
  • I tested my contribution locally and it seems to work fine.
  • Code and workflow changes are sufficiently documented.
  • Newly introduced dependencies are added to envs/environment.yaml and doc/requirements.txt.
  • Changes in configuration options are added in all of config.default.yaml and config.tutorial.yaml.
  • Add a test config or line additions to test/ (note tests are changing the config.tutorial.yaml)
  • Changes in configuration options are also documented in doc/configtables/*.csv and line references are adjusted in doc/configuration.rst and doc/tutorial.rst.
  • A note for the release notes doc/release_notes.rst is amended in the format of previous release notes, including reference to the requested PR.

@ekatef ekatef changed the title Fix displaying the options wildcard Fix displaying the options wildcard in read-the-docs Dec 4, 2023
@davide-f
Copy link
Member

davide-f commented Dec 8, 2023

Cool @ekatef :)
For me this is fine and I believe no conflicts should appear with #918 : in #918 no changes are (yet) included on that file.
Since you are investigating that PR, do you foresee changes on the opts file?
If not, we can merge this PR

@ekatef
Copy link
Collaborator Author

ekatef commented Dec 8, 2023

Cool @ekatef :) For me this is fine and I believe no conflicts should appear with #918 : in #918 no changes are (yet) included on that file. Since you are investigating that PR, do you foresee changes on the opts file? If not, we can merge this PR

Thanks a lot @davide-f!
As a second thought, #918 is focused on improving explanations for installation and tutorials, which shouldn't go into configtables. So, agree that the conflicts with this PR are not likely 🙂

@davide-f
Copy link
Member

davide-f commented Dec 9, 2023

Super :)
Merging

@davide-f davide-f merged commit 84a0aa4 into pypsa-meets-earth:main Dec 9, 2023
4 checks passed
@ekatef
Copy link
Collaborator Author

ekatef commented Dec 9, 2023

Super :) Merging

Thanks a lot!!

@ekatef ekatef deleted the fix_opts_docs branch December 26, 2023 08:51
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.

None yet

2 participants