diff options
author | Jarrod Millman <jarrod.millman@gmail.com> | 2017-07-17 11:24:00 -0700 |
---|---|---|
committer | Dan Schult <dschult@colgate.edu> | 2017-07-17 14:24:00 -0400 |
commit | 471294a157b6cec8d53c36f9e6ceb5ff44c692e1 (patch) | |
tree | d036c97af82b9be0b13261c72e61a49c3413100c /doc/Makefile | |
parent | 7a138a1bab6e9eefa92883dfa11fcb45dc8347ca (diff) | |
download | networkx-471294a157b6cec8d53c36f9e6ceb5ff44c692e1.tar.gz |
Fix sphinx (#2517)
* Ensure valid rst file
* Edit text
* Update README and package docstring
* Add myself as a contributor
* Update gitwash
* Fix warnings/errors except citations/footnotes
* Remove old note about 3.0 incompatibility
* Remove stale ref to gh-pages
* Create top-level tools directory (standard practice)
* Use sphinx-gallery extension for examples
* Sphinx-gallery generates images for `plot_` examples
* Comply with pep8
* Don't save figures
Diffstat (limited to 'doc/Makefile')
-rw-r--r-- | doc/Makefile | 40 |
1 files changed, 15 insertions, 25 deletions
diff --git a/doc/Makefile b/doc/Makefile index 4138470e..33b582f8 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -26,19 +26,11 @@ help: @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " gitwash to update the gitwash documentation" clean: - -rm -rf build/* source/reference/generated/* source/examples/* source/static/examples/* doc/source/*.pdf doc/source/*.zip - -rm -rf ../examples/*/*.png - -generate: build/generate-stamp -build/generate-stamp: $(wildcard source/reference/*.rst) - mkdir -p build - python make_gallery.py - python make_examples_rst.py ../examples source - touch build/generate-stamp - + -rm -rf build/* source/auto_examples source/modules source/reference/generated dist: html test -d build/latex || make latex @@ -48,33 +40,33 @@ dist: html (cd build/dist && tar czf ../dist.tar.gz .) -html: generate +html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html @echo @echo "Build finished. The HTML pages are in build/html." -dirhtml: generate +dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml @echo @echo "Build finished. The HTML pages are in build/dirhtml." -pickle: generate +pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle @echo @echo "Build finished; now you can process the pickle files." -json: generate +json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json @echo @echo "Build finished; now you can process the JSON files." -htmlhelp: generate +htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in build/htmlhelp." -qthelp: generate +qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ @@ -89,7 +81,7 @@ epub: @echo "Build finished. The epub file is in $(BUILDDIR)/epub." -latex: generate +latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex @echo @echo "Build finished; the LaTeX files are in build/latex." @@ -101,21 +93,19 @@ changes: @echo @echo "The overview file is in build/changes." -linkcheck: generate +linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in build/linkcheck/output.txt." -doctest: generate +doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in build/doctest/output.txt." -gh-pages: clean dist - python gh-pages.py $(tag) - gitwash-update: - python gitwash_dumper.py source/developer networkx \ - --project-url=http://networkx.github.io \ - --project-ml-url=http://groups.google.com/group/networkx-discuss/ + python ../tools/gitwash_dumper.py source/developer networkx \ + --project-url=http://networkx.github.io \ + --project-ml-url=http://groups.google.com/group/networkx-discuss/ \ + --gitwash-url git@github.com:matthew-brett/gitwash.git |