-
Notifications
You must be signed in to change notification settings - Fork 17
Final changes for notebook support #125
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
Conversation
|
|
||
| .PHONY: help Makefile | ||
| # Build all Sphinx docs locally, except the notebooks | ||
| no-nb no-notebooks: |
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.
This is really helpful!
| @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(EXCLUDENB) $(O) | ||
|
|
||
| # Cleans up files generated by the build process | ||
| clean: |
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.
Thank you!
| SOURCEDIR = . | ||
| BUILDDIR = ../_readthedocs/ | ||
|
|
||
| .PHONY: help no-nb no-notebooks clean Makefile |
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.
I am used to seeing .PHONY at the end of the Makefile but I do not know if it matters. Its sole purpose is to declare targets that do not represent actual files. So I do not think that Makefile needs to be present (unless you noticed some error?)
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.
The initial Makefile that Sphinx generates has the line .PHONY: help Makefile, so I reasoned it was best keep it if I had no specific reason to remove it.
Based on this SO, it seemed to me like it's there to make sure whatever targets are captured by %: Makefile are always run, and--this part goes a little over my head--the presence of Makefile as a dependency of % to avoid weird GNU Make behavior. (But please let me know if you have any thoughts!)
|
This looks great @olivialynn, nice work! |
Some notes: