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

Enable docs build on ReadTheDocs #154

Merged
merged 18 commits into from
Feb 22, 2019
Merged

Enable docs build on ReadTheDocs #154

merged 18 commits into from
Feb 22, 2019

Conversation

khaeru
Copy link
Member

@khaeru khaeru commented Jan 23, 2019

In this PR, I've done the following:

  • add the necessary pieces for the documentation to be built on ReadTheDocs,
  • change the theme to the RTD default theme with the IIASA logo,
  • rearrange and simplify duplicated contents, especially in the user/contributor guidelines and FAQ.

I have temporarily (i.e. this will not be the final URL) enabled the build for this branch (feature/rtd), which is available at:

https://message-ix.readthedocs.io/en/feature-rtd/

  • Merge Improve documentation #138 and ensure build still works.
  • Set up CNAME or redirects from IIASA ENE domains & corresponding RTD config.
  • Consider subprojects or other configuration for building docs of MESSAGE-GLOBIOM and ixmp separately → don't use
  • PR checklist:
    • Tests added (n/a)
    • Documentation added (n/a)
    • Description in RELEASE_NOTES.md added

Closes

Separately

If we want to enable RTD hosting of older versions (e.g. v1.0.0, v1.1.0), then we will need to:

  1. Establish maintenance branches for each version.
  2. Add a minimal commit to each branch with changes necessary for the RTD build to work.

@khaeru khaeru added the docs Documentation label Jan 23, 2019
@khaeru khaeru changed the title [WIP] enable docs build on ReadTheDocs [WIP] Enable docs build on ReadTheDocs Jan 24, 2019
@khaeru
Copy link
Member Author

khaeru commented Jan 30, 2019

  • Set up CNAME from IIASA ENE domains & corresponding RTD config.

This was discussed in today's development meeting, work is on hold pending a decision…

@khaeru khaeru changed the title [WIP] Enable docs build on ReadTheDocs Enable docs build on ReadTheDocs Feb 7, 2019
@khaeru
Copy link
Member Author

khaeru commented Feb 8, 2019

Last thing pending is a decision from @volker-krey on what domain/path these will live under.

@khaeru khaeru requested a review from gidden February 8, 2019 10:36
@gidden
Copy link
Member

gidden commented Feb 8, 2019

Looks great @khaeru. What did we decide on migrating tutorials to static doc pages? I know gams was the pain point, but did we come to a conclusion?

@khaeru
Copy link
Member Author

khaeru commented Feb 8, 2019

@gidden I think the idea was to:

  1. Install GAMS as an optional target of message_ix/ixmp.
  2. Do this on RTD.
  3. Render the tutorials within Sphinx, either from ipynbs or inline content.

I would personally prefer static docs pages, since that seems more in line with what's done by other Pydata packages. Either way, that's a separate can of worms, so we can open a new issue…

@gidden
Copy link
Member

gidden commented Feb 8, 2019

Agreed. Ok, so we have the scripts to do so on CI, but I would need to read up on how to make setup.py do something like this specifically for a target. Perhaps a custom Install class?

@khaeru
Copy link
Member Author

khaeru commented Feb 8, 2019

Either way, that's a separate can of worms, so we can open a new issue…

Opened #165 for that discussion.

@khaeru
Copy link
Member Author

khaeru commented Feb 22, 2019

Okay @gidden I think this is ready to merge, if you do.

I will make another PR if needed to implement the final domain/URL scheme.

@gidden gidden merged commit 8cd9237 into master Feb 22, 2019
@gidden
Copy link
Member

gidden commented Feb 22, 2019

Amazing work, thanks @khaeru!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants