-
Notifications
You must be signed in to change notification settings - Fork 3
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
add git-lfs instructions to download page #59
Conversation
@mwetter I just added a note box at the top of the download section to speficy that LFS needs to be installed before cloning the repo. I put a link to the installation steps, since it is different for Linux and Windows users. |
@bravache : I should have mentioned that the changes will need to be made in the rst file at https://github.com/lbl-srg/soep/blob/master/doc-design/source/download.rst and then the html file can then be generated as described at https://github.com/lbl-srg/soep/tree/master/doc-design |
Thanks @mwetter for the reference. |
doc-design/README.md
Outdated
@@ -14,7 +14,7 @@ and a few contributions, which can be installed by running | |||
``` | |||
pip3 install --user sphinx | |||
pip3 install --user sphinx_bootstrap_theme | |||
pip3 install --user sphinxcontrib.bibtex | |||
pip3 install --user sphinxcontrib.bibtex==1.0 |
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.
@bravache : I don't think that is needed. I compiled with
$ python3 -m pip freeze | grep bibtex
bibtexparser==1.1.0
sphinxcontrib-bibtex==0.4.2
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.
Well, the issue I am trying to avoid with this line is for version > 2.0. I was running into the error described here:
jupyter-book/jupyter-book#1137,
In particular, this comment was what solved it for me: jupyter-book/jupyter-book#1137 (comment)
Could you check if you can still compile the document with the latest sphinxcontrib.bibtex?
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.
@bravache : Please see my inline comments.
I don't know what causes the error on your system. I compiled it fine on Ubuntu 18.04.
If you are fine with the changes, we can remove the bibtex==1.0 (or set to >=1.0 if needed) and then merge after recreating the files which I can do locally.
No description provided.