summaryrefslogtreecommitdiff
path: root/docs/Makefile
diff options
context:
space:
mode:
authorVishwak Srinivasan <cs15btech11043@iith.ac.in>2018-03-08 23:51:12 +0530
committerSoumith Chintala <soumith@gmail.com>2018-03-08 13:21:12 -0500
commit32b38415535a7a0311cb644b3fddad47b438c401 (patch)
tree99aaabe366f54da2547b54cc3eecae3ad2f58981 /docs/Makefile
parentc16478fe3fb8842119438b8fd79d98c8f50ca688 (diff)
downloadpytorch-32b38415535a7a0311cb644b3fddad47b438c401.tar.gz
pytorch-32b38415535a7a0311cb644b3fddad47b438c401.tar.bz2
pytorch-32b38415535a7a0311cb644b3fddad47b438c401.zip
[ready] General documentation improvements (#5450)
* Improvize documentation 1. Add formula for erf, erfinv 2. Make exp, expm1 similar to log, log1p 3. Symbol change in ge, le, ne, isnan * Fix minor nit in the docstring * More doc improvements 1. Added some formulae 2. Complete scanning till "Other Operations" in Tensor docs * Add more changes 1. Modify all torch.Tensor wherever required * Fix Conv docs 1. Fix minor nits in the references for LAPACK routines * Improve Pooling docs 1. Fix lint error * Improve docs for RNN, Normalization and Padding 1. Fix flake8 error for pooling * Final fixes for torch.nn.* docs. 1. Improve Loss Function documentation 2. Improve Vision Layers documentation * Fix lint error * Improve docstrings in torch.nn.init * Fix lint error * Fix minor error in torch.nn.init.sparse * Fix Activation and Utils Docs 1. Fix Math Errors 2. Add explicit clean to Makefile in docs to prevent running graph generation script while cleaning 3. Fix utils docs * Make PYCMD a Makefile argument, clear up prints in the build_activation_images.py * Fix batch norm doc error
Diffstat (limited to 'docs/Makefile')
-rw-r--r--docs/Makefile7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 210cbc7400..2a63943f00 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -7,13 +7,14 @@ SPHINXBUILD = sphinx-build
SPHINXPROJ = PyTorch
SOURCEDIR = source
BUILDDIR = build
+PYCMD = python
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
figures:
- python source/scripts/build_activation_images.py
+ @$(PYCMD) source/scripts/build_activation_images.py
docset: html
doc2dash --name $(SPHINXPROJ) --icon $(SOURCEDIR)/_static/img/pytorch-logo-flame.png --enable-js --online-redirect-url http://pytorch.org/docs/ --force $(BUILDDIR)/html/
@@ -28,3 +29,7 @@ docset: html
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile figures
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+ @echo "Removing everything under 'build'.."
+ @rm -r $(BUILDDIR)/html/ $(BUILDDIR)/doctrees