-
Notifications
You must be signed in to change notification settings - Fork 235
Improve the targets in doc/Makefile #1014
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
Changes from 8 commits
ccaa560
483e569
290bb2a
5cf3674
4733351
61ff7b7
3cdbb02
13576d6
738dfde
c8043e3
e719f74
c0249c7
a98e55f
4befb89
c9d6f3e
3f1dd80
302830f
25d5855
859326b
f75eb41
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -7,29 +7,19 @@ SPHINXAUTOGEN = sphinx-autogen | |||||||||||||||||
| BUILDDIR = _build | ||||||||||||||||||
|
|
||||||||||||||||||
| # Internal variables. | ||||||||||||||||||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . | ||||||||||||||||||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . | ||||||||||||||||||
|
|
||||||||||||||||||
| .PHONY: help clean html linkcheck doctest api | ||||||||||||||||||
|
|
||||||||||||||||||
| all: html | ||||||||||||||||||
|
|
||||||||||||||||||
| help: | ||||||||||||||||||
| @echo "Please use \`make <target>' where <target> is one of" | ||||||||||||||||||
core-man marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
| @echo " all generate the complete webpage" | ||||||||||||||||||
core-man marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||
| @echo " html make only the HTML files from the existing rst sources" | ||||||||||||||||||
| @echo " linkcheck check all external links for integrity" | ||||||||||||||||||
| @echo " doctest run all doctests embedded in the documentation (if enabled)" | ||||||||||||||||||
| @echo " html build the HTML files from the existing rst sources" | ||||||||||||||||||
| @echo " api generate rst source files of API documentation" | ||||||||||||||||||
| @echo " server make a local HTTP server for previewing the built documentation" | ||||||||||||||||||
| @echo " clean clean up built and generated files" | ||||||||||||||||||
|
||||||||||||||||||
| @echo " html build the HTML files from the existing rst sources" | |
| @echo " api generate rst source files of API documentation" | |
| @echo " server make a local HTTP server for previewing the built documentation" | |
| @echo " clean clean up built and generated files" | |
| @echo " api generate rst source files of API documentation" | |
| @echo " clean clean up built and generated files" | |
| @echo " html build the HTML files from the existing rst sources" | |
| @echo " server make a local HTTP server for previewing the built documentation" |
I'd also prefer it if the rest of this Makefile was sorted alphabetically (i.e. all, api, clean, html, server), while keeping this help target on top of course.
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.
People usually put clean to be the last one, while the target like all or install/build/html is the first one in a makefile. Shall we keep this rule? @seisman @willschlitzer How do you think?
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 prefer to put clean at the bottom.
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.
Uh oh!
There was an error while loading. Please reload this page.