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

Added a ReadTheDocs for OSeMOSYS Global #138

Merged
merged 13 commits into from
Oct 6, 2022
Merged

Added a ReadTheDocs for OSeMOSYS Global #138

merged 13 commits into from
Oct 6, 2022

Conversation

trevorb1
Copy link
Member

Description

  • Used PyScaffold to update the directory structure for OSeMOSYS Global. This helped in sorting out what files are needed for read the docs, but also allows OSeMOSYS Global to be packaged for PyPI (Issue Setup osemosys_global as an installable Python package and deploy to PyPI #34)
  • Added a readthedocs site (https://osemosys-global-test.readthedocs.io/en/docs/).
    • Included in the docs are installation instructions, working examples, model structure details, and the contributors guide.
    • The API docs of the site has been commented out for the time being since we haven't been consistent with docstrings and what not. So getting that sorted will be a separate task.
  • Model functionality has not changed

NOTE
The test site is connected to a fork linked to my GitHub account, which works fine for testing. When I tried to link it directly to the repository on OSeMOSYS' GitHub I was running into weird syncing and permission issues. Maybe @abhishek0208 or @tniet could try hosting the site to see if they get the same issues? Thats why the current URL is called osemosy-global-test.

Issue Ticket Number

Closes #70

Documentation

@tniet
Copy link
Contributor

tniet commented Sep 29, 2022

Looks good to me, @trevorb1! If @abhishek0208 is good with things I can click the merge button and we can see what happens?

@tniet tniet merged commit a7eae16 into master Oct 6, 2022
@trevorb1 trevorb1 deleted the docs branch October 19, 2022 09:06
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.

Add ReadTheDocs structure to repo
2 participants