-
Notifications
You must be signed in to change notification settings - Fork 42
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
first pass at getting sphinx and automodapi running #53
Conversation
Removing RTD files. Have been told that RTD has no plans to run on private repos. |
Sorry for the delay @SaraOgaz, I'll look at this tomorrow or Friday |
# import os | ||
# import sys | ||
# sys.path.insert(0, os.path.abspath('.')) | ||
import stsci_rtd_theme |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SaraOgaz This is really nice to have! I want to switch all of my other projects to use this 0_0
Welcome to jwql's documentation! | ||
================================ | ||
|
||
General JWQL description here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SaraOgaz I can add some documentation here, but I will do that in a separate PR.
environment.yml
Outdated
@@ -1,4 +1,4 @@ | |||
name: jwqldev | |||
macs name: jwqldev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SaraOgaz What does this do?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not remember changing that.... I will change it back.
Thanks @SaraOgaz, this all looks good. Though I don't think I will merge this until I can properly build the docs locally. Right now I am encountering trouble building the
|
@SaraOgaz I was able to build the
What is the deal with this |
@SaraOgaz I should also mention that I had to add |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @SaraOgaz, this looks good and builds on our dev server. There are some warnings dealing with specific docstrings in preview_image.py
, but I'll take care of those in a separate PR. I'll also add project documentation in a separate PR.
first pass at getting sphinx and automodapi running
not storing automodapi generated docs for now. #51
Things I needed to add to env for this PR:
through "conda install":
stsci_rtd_theme
sphinx_rtd_theme
numpydoc
update conda install of astropy to 3.0 or above
I also had to "pip install sphinx-automodapi"