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

Equation bank removal and upgrade to current sphinx #546

Merged
merged 15 commits into from
Jan 2, 2019

Conversation

lheagy
Copy link
Member

@lheagy lheagy commented Jan 2, 2019

Upgrade sphinx version

  • remove dependency on sphinx 1.4.8 and docutils 0.12 and depend on latest versions (closes update to current software versions #428)
  • all development should now take place on the most recent version of sphinx. If you use conda, please run
conda update sphinx

and if you use pip

pip install --upgrade sphinx
  • deploy docs from python 3

Equation bank

  • temporarily remove usage of equation bank: we are running into errors with multiple references to a single equation. In order to overcome this, we will need a custom solution to label the equations uniquely for each usage. This is outlined in issue equation bank #547
  • fix equation labels. All equations should be labeled with :label: (not :name:)

Unused references

  • currently quite a number of references are not actually referred to in the text. This is causing warnings in the build process. I have temporarily removed those references from the main bibliography and have put them in unused_references.bib. Presumably they were initially included because we intended to use them, and it might indicate that citations are not properly formatted in the site. I have created issue unused references  #548 to keep track of this.

This was referenced Jan 2, 2019
@lheagy
Copy link
Member Author

lheagy commented Jan 2, 2019

@dccowan: would you mind giving this a quick review? I am happy to answer any questions you have. This will hopefully resolve the issues you were running into the other day

@dccowan dccowan self-requested a review January 2, 2019 21:41
@dccowan
Copy link
Member

dccowan commented Jan 2, 2019

@dccowan: would you mind giving this a quick review? I am happy to answer any questions you have. This will hopefully resolve the issues you were running into the other day

@lheagy I upgraded to the latest requirements and was able to successfully build the website locally. It seems like some of the original citations for some of the case histories have been replaced by new ones which reference SEG owned materials. If we are confident these are the correct citations, I can remove/comment the redundant ones.

@dccowan dccowan self-assigned this Jan 2, 2019
@lheagy
Copy link
Member Author

lheagy commented Jan 2, 2019

sounds good, thanks @dccowan: lets get this merged first and then you can make changes on a new branch so it is a bit better scoped. If you are happy with this, can you please approve the pr?

https://github.com/geoscixyz/em/pull/546/files

image

@lheagy lheagy merged commit b9f03ff into master Jan 2, 2019
@lheagy lheagy deleted the equation-bank-removal branch January 2, 2019 21:55
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.

update to current software versions
2 participants