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

Pin sphinx to version 1.8.5 #59

Merged
merged 1 commit into from
Apr 24, 2019
Merged

Pin sphinx to version 1.8.5 #59

merged 1 commit into from
Apr 24, 2019

Conversation

santisoler
Copy link
Member

New versions of Sphinx (2.0.0, 2.0.1) create unexpected wrong format on docstrings.
A momentarily solution is to pin Sphinx to the last version before 2.0.0: 1.8.5.
We should go back to the latest Sphinx release when this bug is fixed on their
repository.

Fixes #58

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

@leouieda leouieda merged commit 5b8258c into fatiando:master Apr 24, 2019
@santisoler santisoler deleted the sphinx branch July 17, 2019 15:26
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

Successfully merging this pull request may close these issues.

Ugly docstrings generated by Sphinx
2 participants