Skip to content

Moving from make.py to Makefile for sphinx-build #9712

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.

Sign up for GitHub

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

Closed
wants to merge 11 commits into from
Closed

Moving from make.py to Makefile for sphinx-build #9712

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ed77ecd
MAINT moving to modern way of building docs.
NelleV Oct 14, 2017
0dadf73
DOC FIX doc build options
NelleV Oct 14, 2017
25c0567
MAINT update circle-ci to use conda environments
NelleV Oct 14, 2017
81b9e8b
DOC update the documentation on writing doc
NelleV Oct 14, 2017
0918e2b
debugging attempt
NelleV Oct 14, 2017
9949203
MAINT circe-ci uses doc-requirements.txt
NelleV Oct 15, 2017
ee3e3a4
FIX the doc build directory is 'build' not '_build'
NelleV Oct 15, 2017
4ffb328
FIX adding current dir to examples that need local imports
NelleV Oct 19, 2017
1ea144c
MAINT Go look for linkchecker in the correct dir
NelleV Oct 19, 2017
6a725f0
Matplotlib doesn't build doc in html/stable
NelleV Oct 19, 2017
616751d
MAINT remove the depsy badge
NelleV Oct 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC FIX doc build options
  • Loading branch information
@NelleV
NelleV committed Nov 7, 2017
commit 0dadf739fd4d13f68b5e3a1d2b63d84648c6433c
6 changes: 3 additions & 3 deletions doc/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ generated.

You can build the documentation with several options:

* `--small` saves figures in low resolution.
* `--allowsphinxwarnings`: Don't turn Sphinx warnings into errors.
* `-n N` enables parallel build of the documentation using N process.
* `make html-noplot` doesn't save the gallery's images. Allows for fast build.
* `make html-allow-warnings`: Don't turn Sphinx warnings into errors.
* `make -j N` enables parallel build of the documentation using N process.

Organization
-------------
Expand Down