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

Refactor documentation #97

Closed
gonsie opened this issue Oct 26, 2017 · 5 comments
Closed

Refactor documentation #97

gonsie opened this issue Oct 26, 2017 · 5 comments
Assignees
Milestone

Comments

@gonsie
Copy link
Member

gonsie commented Oct 26, 2017

No description provided.

@adammoody adammoody self-assigned this Dec 21, 2017
@adammoody
Copy link
Contributor

I RST-ified the user guide latex files yesterday so that we can move it to readthedocs.

@adammoody
Copy link
Contributor

I pushed this to our internal SCR docs repo for now.

@adammoody
Copy link
Contributor

Now here: #111

@gonsie
Copy link
Member Author

gonsie commented Jan 2, 2018

Woohoo! The documenation is now live at scr.readthedocs.io.

Still left to do:

  • check settings at RTD
  • add triggers so the docs get automatically rebuilt
  • easy way to get the pdf back into the repo? That way the latest is always installed
  • update / add links to readme

@gonsie gonsie added this to the v1.2.1 milestone Jan 3, 2018
@gonsie
Copy link
Member Author

gonsie commented Jan 22, 2018

This is addressed by a fix to #115. There is no automated way to get the pdf back into the repo, but we can do that manually for now.

@gonsie gonsie closed this as completed Jan 22, 2018
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

No branches or pull requests

2 participants