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

switch docs theme to alabaster, rework index and data model pages #277

Merged
merged 18 commits into from
Oct 30, 2019

Conversation

danielhuppmann
Copy link
Member

@danielhuppmann danielhuppmann commented Oct 28, 2019

Please confirm that this PR has done the following:

  • Description in RELEASE_NOTES.md Added

Description of PR

This PR implements a number of clean-up and editorial changes in the docs pages in preparation for the next release. In particular:

  • switch to Sphinx standard theme alabaster (recommended by RTD, similar to existing theme)
  • add GitHub "Watch" button in sidebar
  • restructure index page, move "Support and Contributing" to own page, add reference to JOSS manuscript
  • rewrite and extend "Data model" page, add more details on IAMC and history

The updated rendered pages are available at https://pyam-iamc.readthedocs.io/en/docs-datamodel/

@danielhuppmann
Copy link
Member Author

@gidden, I tried to clean up the docs dependencies, but I'm a bit confused between contradicting specs:

  • extensions imported in doc/source/conf.py
  • installed packages in doc/environment.yml
  • doc/README.md
  • doc/requirements.txt

Which list takes priority here?

@coveralls
Copy link

coveralls commented Oct 28, 2019

Coverage Status

Coverage remained the same at 91.036% when pulling e99cc65 on docs/datamodel into 1627f56 on master.

@gidden
Copy link
Member

gidden commented Oct 30, 2019

Looks amazing!!

@gidden gidden merged commit 1319fe4 into master Oct 30, 2019
@gidden gidden deleted the docs/datamodel branch October 30, 2019 08:11
@gidden gidden mentioned this pull request Oct 30, 2019
@danielhuppmann danielhuppmann restored the docs/datamodel branch October 30, 2019 22:19
@danielhuppmann danielhuppmann deleted the docs/datamodel branch October 30, 2019 22:19
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.

3 participants