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

Fix doc build (a bit) #910

Merged
merged 6 commits into from
Sep 6, 2022
Merged

Conversation

jlmelville
Copy link
Collaborator

Me again. Yes, I am on a tear today.

When sphinx 1.8 came out (back in, er, 2018), the api changed add_javascript to add_js_file. I have updated the conf.py to reflect this and set a minimum requirement in docs_requirements.txt (although I can't imagine the latter being an actual problem).

Now I get a fair number of errors when I run sphinx-build but they are of the fixable type rather than of the oops-sphinx-exploded type.

Also I added a section to the CONTRIBUTING.MD about how to build the docs locally. I set the build output to that specified in doc/Makefile (which is _build) although I couldn't get make or make help to actually do anything.

Finally, I added the build output to .gitignore.

@lmcinnes
Copy link
Owner

lmcinnes commented Sep 6, 2022

Thanks for this. I admit I haven't been paying attention to the doc builds recently, so noting that sphinx changed and it got broken is greatly appreciated.

@lmcinnes lmcinnes merged commit cc7de85 into lmcinnes:master Sep 6, 2022
This pull request was closed.
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.

2 participants