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

first pass at getting sphinx and automodapi running #53

Merged
merged 4 commits into from
Apr 17, 2018
Merged

first pass at getting sphinx and automodapi running #53

merged 4 commits into from
Apr 17, 2018

Conversation

SaOgaz
Copy link
Collaborator

@SaOgaz SaOgaz commented Apr 4, 2018

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"

@SaOgaz SaOgaz requested a review from bourque April 4, 2018 15:09
@SaOgaz
Copy link
Collaborator Author

SaOgaz commented Apr 4, 2018

Removing RTD files. Have been told that RTD has no plans to run on private repos.

@SaOgaz SaOgaz changed the title WIP: first pass at getting sphinx and automodapi running first pass at getting sphinx and automodapi running Apr 4, 2018
@bourque
Copy link
Collaborator

bourque commented Apr 11, 2018

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
Copy link
Collaborator

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.
Copy link
Collaborator

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
Copy link
Collaborator

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?

Copy link
Collaborator Author

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.

@bourque
Copy link
Collaborator

bourque commented Apr 13, 2018

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 jwqldev environment (and hence the docs) because our dependency on jwst package in astroconda-dev seems broken:

CondaError: MD5MismatchError: Conda detected a mismatch between the expected content and downloaded content
for url 'http://ssb.stsci.edu/astroconda-dev/osx-64/cfitsio-3.440-3.tar.bz2'.
  download saved to: /Users/bourque/anaconda2/pkgs/cfitsio-3.440-3.tar.bz2
  expected md5 sum: 237893ac8e404d775bf72d78d7885b6c
  actual md5 sum: da34db3f1503914ab65ea79cb184e503

@bourque
Copy link
Collaborator

bourque commented Apr 17, 2018

@SaraOgaz I was able to build the jwqldev environment and API docs locally without much hassle. The only thing I had to change was the first line of environment.yml from macs name: jwqldev back to name: jwqldev, otherwise I get this error:

(astroconda3) [kramer:jwql] conda env create -f environment.yml
Using Anaconda API: https://api.anaconda.org

SpecNotFound: Can't process without a name

What is the deal with this macs name? What does it do? Is it necessary?

@bourque
Copy link
Collaborator

bourque commented Apr 17, 2018

@SaraOgaz I should also mention that I had to add numpydoc_show_class_members = False to avoid WARNING: toctree contains reference to nonexisting document 'api/jwql.preview_image.preview_image.PreviewImage.some_method' warnings. Not sure why or how it works at this moment, but some amount of googling lead me to this solution.

Copy link
Collaborator

@bourque bourque left a 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.

@bourque bourque merged commit d95d028 into spacetelescope:master Apr 17, 2018
@bourque bourque deleted the sphinx_setup branch April 17, 2018 18:20
bourque added a commit to bourque/jwql that referenced this pull request Apr 2, 2019
first pass at getting sphinx and automodapi running
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants