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

Initial setup of repo structure #1

Merged
merged 16 commits into from
Feb 17, 2021
Merged

Initial setup of repo structure #1

merged 16 commits into from
Feb 17, 2021

Conversation

danielhuppmann
Copy link
Member

This PR adds the minimal ingredients to develop a simple Python package and build docs using the RTD-sphinx theme adapted to the IIASA design guidelines.

@danielhuppmann danielhuppmann self-assigned this Feb 15, 2021
@danielhuppmann
Copy link
Member Author

And now it even has a GitHub Actions workflow to make sure that the docs can be built...

Copy link
Member

@khaeru khaeru left a comment

Choose a reason for hiding this comment

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

Looks great!

Someone recently linked me to https://github.com/cjolowicz/cookiecutter-hypermodern-python that uses a whole bunch of advanced tools that are mostly unfamiliar and maybe not needed for our use-case.

In contrast, I think it's best to have a stub like this one as a pared-down example that's more relevant (and accessible) to IIASA developers. But, the README could also link to other stub and “cookie-cutter” repos, or to repos like pandas, xarray, etc. that we look to as examples of good practice.

.github/workflows/build-docs.yml Outdated Show resolved Hide resolved
doc/Makefile Show resolved Hide resolved
doc/source/_static/iiasa.css Show resolved Hide resolved
doc/source/conf.py Show resolved Hide resolved
setup.cfg Show resolved Hide resolved
setup.cfg Show resolved Hide resolved
.github/workflows/build-docs.yml Outdated Show resolved Hide resolved
.github/workflows/build-docs.yml Show resolved Hide resolved
.github/workflows/build-docs.yml Outdated Show resolved Hide resolved
@danielhuppmann
Copy link
Member Author

Thanks @khaeru for the constructive comments...

@danielhuppmann danielhuppmann merged commit e9cd075 into main Feb 17, 2021
@danielhuppmann danielhuppmann deleted the initial-setup branch February 17, 2021 13:44
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.

2 participants