Skip to content

Conversation

aburrell
Copy link
Member

Fixes bug in documentation where docstrings were not showing up on readthedocs. Partially addresses #35.

Also fixes setup.py, adding PyForecastTools as a requirement and making some style fixes.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

This has been tested by running the branch on readthedocs.

Test Configuration:

  • Operating system: readthedocs
  • Version number: 3.7.8

Checklist:

  • Make sure you are merging into the develop (not master) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Fixed bug where PyForecastTools wasn't required in setup.py and removed
unnecessary requirements of numpy and pysat in requirements.txt.
Added requirements for readthedocs.
Removed unnecessary comments, changed import order to be alphabetical,
and removed python 2.7 classifier.
@aburrell aburrell added bug Something isn't working documentation Improvements or additions to documentation labels Apr 17, 2020
@aburrell aburrell added this to the 1.0.0 release milestone Apr 17, 2020
Copy link
Collaborator

@rstoneback rstoneback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see the docstrings on readthedocs.

PyForecastTools is excluded from pysat's requirements on RTD so that's how this came about. Used to be that Fortran stuff didn't work. Glad it does now, I didn't remember that it was Fortran when discussing it earlier.

@aburrell
Copy link
Member Author

It's not fortran, so I am not sure how it ended up on that list to begin with. In any case, problem now solved!

@aburrell aburrell merged commit 043505e into develop Apr 17, 2020
@aburrell aburrell deleted the docstring_bug branch April 17, 2020 14:30
@rstoneback
Copy link
Collaborator

rstoneback commented Apr 17, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants