-
Notifications
You must be signed in to change notification settings - Fork 23
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
RTD sphinx format updates #141
base: master
Are you sure you want to change the base?
Conversation
This should hopefully allow the RTD environment to build.
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.
Looks good. Feel free to merge
I tried building the docs in a separate RTD version. Something happened to the formatting we should work out before merging. This might be caused by a change to the Sphinx version? |
…nal "string" to "str" in datatype descriptions.
|
@starphire - |
@stscirij - |
Note that PR #145 also changes the RTD configuration. Haven't resolved the differences yet. |
Would adding the python:
version: 3.8
install:
- method: pip
path: .
extra_requirements:
- docs EDIT: I apologize, I misread the PR; I thought the issue was selectively adding docs requirements, instead of removing them. |
@stscirij @starphire - |
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.
Formatting looks good, and search bar removal probably is probably better off. Feel free to merge!
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.
The numpy/scipy docstring format calls for a space between a parameter and the colon (and most of the changes in this PR involve removing that space). Not exactly sure why, but jwst follows this practice.
Ideally we shouldn't have to change the docstrings out of compliance. Just found something about the theme possibly causing problems with the colons in the parameter lists ( I'll look into this a bit more first. |
This PR allows the RTD environment to build.PRs #145 + #151 fixed the RTD build issue, but this PR resolves formatting issues in the docs.
Build was failing due to time-out or memory exhaustion on the RTD server. Now mocking many packages and selectively installing them based on theREADTHEDOCS
environment variable.Sphinx issues rectified by modifying docstrings.
Also updated RTD environment to Python 3.7.New build of docs available for review here:
https://stistools.readthedocs.io/en/sl_rtd-env/
vs current build:
https://stistools.readthedocs.io/en/latest/
Note that the TOC now displays various helper functions. We need to decide if this should be suppressed.